CLI
vector the first party command line for scripts and CI
Scoped tokens, JSON output, stable exit codes, and built-in retries. The CLI covers the core workspace operations scripts and CI need: issues, comments, context bundles, deploy markers, and NorthGraph workflows under the same workspace and private-team rules.
$ vectorgraph north diff analyze --base main --json
"verdict": "violations",
"risk": "high",
"summary": { "filesChanged": 14, "routesImpacted": 1 }
Release package path
Install after publication authenticate and issue a token
The package path is implemented and release-gated. It becomes a public install command after the npm release publishes @vectorgraph/cli@0.1.0 from the release commit. Until then, use /cli/v1 directly for workspace JSON and treat packaged CLI examples as release-candidate commands.
- 01
Install after npm publication
npm install --global @vectorgraph/cli@0.1.0 - 02
Authenticate against your workspace
vectorgraph auth login --workspace acme - 03
Issue a scoped token for CI
vectorgraph tokens create --scope deploy:write --ttl 90d
The commands teams reach for first
Six commands cover the work most automations need
Everything else the binary supports follows the same conventions: JSON output, stable exit codes, scoped tokens, retries built in. Run vectorgraph --help for the full surface.
vectorgraph issues queryRead and filter issues. Pipe straight into jq, a Slack post, or a CSV export. Stable schema for CI scripts.
vectorgraph issues createOpen issues from any automation with full field support. Idempotency keys mean retries don't double-file.
vectorgraph ask submitCapture customer signal from support pipelines, analytics anomaly handlers, or sales call notes.
vectorgraph deploy markTag a deploy. Auto-closes the issues in the release and notifies the originating signal requesters.
vectorgraph context bundleFetch the same permission-filtered context bundle agents see through MCP. Useful for hybrid scripts.
vectorgraph north diff analyzeRun NorthGraph against a diff locally. Same verdict your CI gate will see, returned as structured JSON.
A real session
JSON output you can pipe directly into the next command
Stable schema, predictable keys, ISO timestamps. The output below shows the release binary contract against this repository's workspace.
# Find every open ENG issue without a linked PR$ vectorgraph issues query --team eng --status started --no-pr --json \ | jq -r '.issues[] | .identifier'ENG-2189ENG-2204ENG-2211 # Mark a deploy and auto-close the issues it shipped$ vectorgraph deploy mark --sha c93af1e --env production --json{ "deploy": "2026.05.14", "sha": "c93af1e", "closed_issues": ["ENG-2189"], "notified_signals": ["SIG-441"], "actor": "ci-deploy-bot", "result": "ok"}In your pipeline
Drop into any CI in two lines
Use the official GitHub Action after the release workflow publishes it, or call the binary directly from any shell. Stable exit codes mean a failed NorthGraph check fails the build, no parsing required.
# .github/workflows/north-graph.ymlname: NorthGraph analyzeon: pull_request: jobs: analyze: runs-on: ubuntu-latest steps: - uses: actions/checkout@v6.0.2 - uses: vectorgraph/setup-vectorgraph@v1 with: token: ${{ secrets.VECTORGRAPH_TOKEN }} - run: vectorgraph north diff analyze --base origin/main --jsonGet started
Bring your team onto the shared work graph
Create an account, name a workspace, invite your team, connect your code, and point your agents at MCP. Start turning company context into shipped work from one shared workspace.