GitDocket Star on GitHub

Install GitDocket

GitDocket 0.6.4 is a public preview: expect rough edges and review agent changes. Public preview describes product maturity; the published packages use the latest channel and the GitHub release is not marked as a prerelease. See the 0.6.4 release notes.

Install GitDocket with Homebrew and verify both commands:

brew install gitdocket/tap/gitdocket &&
  docket --version &&
  docket-mcp --version

If installation fails or your agent cannot find Docket, check the supported platforms and command-path guidance, or ask for help.

This installs docket, the command-line tool, and docket-mcp, which connects your coding agent to the project. Continue with Getting started. If you already use Node 22+, npm is another installation option.

Supported platforms

You need Git and Homebrew. GitDocket supports:

Windows, Alpine/musl Linux and 32-bit systems are unsupported. Mac release checks run on Apple Silicon, with Intel compatibility checked through Rosetta rather than physical Intel hardware. Linux must meet Homebrew’s system requirements.

About the tap

The command uses the project-maintained GitDocket/homebrew-tap. On Homebrew 6 and later, the fully qualified command grants trust to this formula. See Homebrew tap trust.

Updating and removing

Update the application with:

brew update &&
  brew upgrade gitdocket/tap/gitdocket

From each initialized project directory, preview the supplied-instruction changes:

docket upgrade --dry-run --json

Review the dry-run output and resolve any reported conflicts with your customizations before applying the update:

docket upgrade

Use brew reinstall gitdocket/tap/gitdocket to repair the installation, or brew uninstall gitdocket/tap/gitdocket to remove it. Your project files and agent configuration stay in place.

Moving from npm or Bun

Check which commands your shell currently uses:

type -a docket docket-mcp

Inspect your previous installation with npm ls -g --depth=0 or bun pm ls -g, depending on the installer you used. Install the Homebrew package, then check it directly with $(brew --prefix gitdocket/tap/gitdocket)/bin/docket --version and the corresponding docket-mcp --version.

If Homebrew reports a link collision, remove the old GitDocket packages with their original installer: npm uninstall -g @gitdocket/cli @gitdocket/mcp or bun remove -g @gitdocket/cli @gitdocket/mcp. Review the named paths before removing anything; avoid force-overwriting unknown executables. Run brew link gitdocket/tap/gitdocket, open a new terminal, and check type -a docket docket-mcp again.

An agent may still point to the old executable through .mcp.json, .cursor/mcp.json, .codex/config.toml or its host-level MCP settings. Update any old absolute paths and restart the agent. Re-running docket init preserves custom entries, so check those yourself. For a new Cursor registration, enable Docket in Customize → MCPs.

npm alternative

If you use Node 22 or later, install GitDocket with npm and verify both commands:

npm install -g --include=optional @gitdocket/cli @gitdocket/mcp &&
  docket --version &&
  docket-mcp --version

If installation fails or your agent cannot find Docket, check the supported platforms and command-path guidance, or ask for help.

This installs the command-line tool and the MCP server for your coding agent. Keep optional dependencies enabled: they supply the executable for your platform. The supported platforms are macOS 15+ and glibc Linux on ARM64 or x64; see platform details.

Continue with Getting started.

Run with npx

For a temporary invocation:

npx --yes --package=@gitdocket/cli --package=@gitdocket/mcp docket --version

To initialize a project with npx, first open its Git repository in your terminal. This example enables all three agent adapters; omit any --agent option you do not use:

npx --yes --package=@gitdocket/cli --package=@gitdocket/mcp docket init --agent cursor --agent claude --agent codex

Omit --yes if you want npm to ask before downloading packages. Pin both package versions when you need a reproducible invocation.

npx makes commands available only for that invocation. For an agent that starts MCP later, use a global installation or configure its MCP command as npx --yes --package=@gitdocket/mcp@<version> docket-mcp. Restart the agent after changing that command.

Updating and removing

Update with npm update -g @gitdocket/cli @gitdocket/mcp, or remove the packages with npm uninstall -g @gitdocket/cli @gitdocket/mcp. Your project files stay in place.

After an application update, run docket upgrade --dry-run --json in each project, review the changes, then run docket upgrade. Resolve any conflicts with your customized instructions.

A Bun global installation uses a separate package manager. Follow the migration guide when switching installers or resolving command collisions.

Help and feedback

Stuck during setup, or unsure what to do next? Open a GitHub issue or email me at [email protected] and tell me what you tried. GitHub sign-in is required. Rough impressions and quick notes are welcome; you do not need a diagnosis or a reproducible example to share feedback.

For a bug, include whatever details you have: the GitDocket version (docket --version, if it runs), operating system, coding agent, what you expected, what happened, and steps to reproduce it. A small synthetic example helps. Missing details should not stop you from reporting a problem.

Keep private project content, credentials and personal details out of public issues. Compare your installed version with the release notes to see what changed.