Install
ReJot CLI
The ReJot CLI is used to create and validate manifest files, as well as starting sync services. The
rejot-cli is published to npmjs.com. You can use
your package manager of choice, including Bun, to install the CLI.
npm install -g @rejot-dev/cli yarn global add @rejot-dev/cli bun add -g @rejot-dev/cli After installation, the CLI should be available on your path.
rejot-cli --help
Container Image
The CLI tool is also available as a container image.
docker run --rm ghcr.io/rejot-dev/rejot-cli:main --help
Build From Source
We use Bun as our primary runtime.
git clone git@github.com:rejot-dev/rejot.git
cd ./rejot
bun install
bun run rejot-cli --help
Model Context Protocol (MCP)
The ReJot Model Context Protocol (MCP) server gives LLMs the ability to manipulate, inspect and use ReJot’s tooling. The MCP can be installed through your package manager of choice.
npm install -g @rejot-dev/mcp yarn global add @rejot-dev/mcp bun add -g @rejot-dev/mcp After installation, the MCP server will be available as rejot-mcp. You can configure your editor
to use the MCP server by adding the following configuration to your editor’s configuration file.
{
"mcpServers": {
"rejot-mcp": {
"command": "rejot-mcp",
"args": ["--project", "."]
}
}
}
Not all editors automatically substitute relative paths, such as ”.” for the project root. You might have to manually specify the absolute project root. This should work in Cursor.
For more information, see the documentation for your editor of choice:
Manifest JSON Schema
To make editing manifest files easier, you can configure JSON Schema in your editor. The schema is
included in the @rejot-dev/contract npm package. You can find it in either of these locations:
- Local path:
node_modules/@rejot-dev/contract/schema.json - URL: https://unpkg.com/@rejot-dev/contract@latest/schema.json
VSCode / Cursor
Add the following configuration to your .vscode/settings.json workspace file:
"json.schemas": [
{
"fileMatch": ["rejot-manifest.json"],
"url": "https://unpkg.com/@rejot-dev/contract@latest/schema.json"
}
]
IntelliJ
For IntelliJ-based IDEs, follow the IntelliJ documentation to add custom JSON Schemas to your project.