Install

Install the GraphJin CLI and scaffold a local project.

Install the CLI

Use the install script when you want the native CLI binary:

Shell

curl -fsSL https://graphjin.com/install.sh | bash
graphjin version

The website serves the script at /install.sh; the build syncs it from the repository root before publishing.

Other common development paths:

Shell

npx graphjin serve --demo
brew install dosco/graphjin/graphjin
go install github.com/dosco/graphjin/cmd/graphjin@latest

graphjin serve --demo is the fastest smoke test because it starts with a known schema and sample queries.

Scaffold a project

Shell

graphjin new my-api
cd my-api
graphjin serve

The generated config gives you development defaults, a database connection section, saved-query directories, and templates for source-mode deployments.

Verified by TestCmdNewWritesAgenticAndSourcesTemplates cmd/cmd_new_test.go:14

Verified by TestTemplatesDecodeAsConfig cmd/cmd_new_test.go:45

The scaffold includes environment-specific config files. Use dev.yml for local work, prod.yml for locked-down deployments, and agentic.yml when MCP/catalog/security surfaces are the main interface.

Connect an AI client

Shell

graphjin mcp add codex
graphjin mcp add claude

For hosted GraphJin, point the MCP client at the HTTP endpoint:

Shell

codex mcp add graphjin --url https://graphjin.example.com/api/v1/mcp

See MCP and OAuth for hosted identity flows.