Get started

Install, then confirm the project.

Installation is two commands. Adoption continues in your coding agent: run /cg-warmup and confirm the project context before you start delivery. New repositories and existing ones follow the same path. Needs Node.js 18.17 or newer.

In a terminal

Install, then set up the repository

npm install -g contract-graph
cg init

Run cg init inside the repository you want to change. npm install -g contract-graph installs the cg command. On Windows PowerShell, run cg.cmd init when cg does not start. Init prepares that repository: schemas, skills, and editor support. It does not add Contract Graph to your application. Reload your editor when it asks you to, so your coding agent can see the kit.

In your coding agent

Confirm project context before delivery

/cg-warmup

Warmup does not run by itself. After init, ask for /cg-warmup and confirm the project context before /cg-plan or /cg-prototype. Init creates .agents/cg/project-context.md beside the root contract.yaml. Warmup fills it with a concise, self-contained copy of accepted project intent, including references to its sources, and asks you to confirm that reading.

Choose your first workflow

When the outcome is already understood, plan and deliver with /cg-plan, /cg-produce, and /cg-sign-off. When you still need to see the experience, explore with /cg-prototype, then /cg-sign-off. How those two paths work.

Later skills use the other cg commands. You do not need those commands to use the kit.

How to use What's included

Inside the Dev Kit

What’s included?

The open-source package includes the cg command, agent skills, contracts, schemas, and editor support. It runs inside Antigravity, Claude Code, Codex, Cursor, or GitHub Copilot in VS Code. Support varies by host.

Agent skills

The /cg-* skills guide planning, implementation, review, and verification. They use the CLI tools as work progresses.

CLI tools

The cg command prepares your repository and provides tools for working with and checking the contract graph.

Contracts and project files

Init prepares schemas, skills, and editor support, with .agents/cg/project-context.md beside the root contract.yaml. These files keep project intent and responsibilities alongside the code.

Running cg init again refreshes the kit while keeping your repository’s own contracts and decisions. The Dev Kit is Apache-2.0 licensed and does not become part of your application.

Skills

What each skill is for.

You describe the work. These skills are part of the kit. They carry the work, and they run the cg tools that keep the graph correct. You do not need those tools yourself.

WarmupConfirm project intent and establish or refresh the contract graph. Run this yourself after init, before delivery, on a new or existing repository.
PlanAgree a sprint or an epic: the outcome, the scope, and what you will accept. Agreeing the plan does not start the build.
ProduceImplement the agreed scope. Ask whether to review the selected work together or each item, then continue independent work while an open decision waits.
PrototypeExplore a working experience through feedback when the result still needs to be seen.
Sign-offComplete outstanding implementation, required tests, documentation, verification, and decision consolidation inside the authorized scope.
UnblockRecord a consequential decision the work is waiting on, then resume eligible work.

In chat they appear as /cg-plan, /cg-produce, /cg-prototype, /cg-sign-off, /cg-warmup, and /cg-unblock.

Go further

The written guides.

The docs explain the map, the two styles, and how to update an existing installation. Public schema files are at Schemas. Source is on GitHub (opens in a new tab).

The skills are bundled with the framework. They keep the contract graph correct while they plan, build, review, and finish, using the kit’s tools as they go. The guides explain what those checks cover.