Skip to main content

​
Requirements

  • Node.js 20 or newer (node --version)
  • macOS or Linux — Windows is best-effort until after launch
  • A 9th Protocol account, or an OpenRouter key for BYOK

​
Install

This puts the 9p binary on your PATH:
During private beta the package is not yet on the public npm registry. Beta users get an install line with their invite.

​
Sign in

This prints a short code and opens your browser. Approve the code and the CLI saves credentials to ~/.9p/auth.json with 0600 permissions.
On a headless machine with no browser, use 9p login --paste and supply an access token from the dashboard instead. See Authentication for BYOK, environment variables, and how tokens refresh.

​
Run it

In a TTY this starts the full terminal UI. Add --plain for a bare REPL, which is what you want in CI or over a pipe.

​
Optional setup

9p init writes a 9P.md for standing instructions, or scaffolds an Obsidian-style vault. See Memory.
9p map writes wiki-style notes about your codebase into the vault so later sessions navigate a map instead of re-reading files. See Vault.
Drop a .9p/mcp.json in the project to add any MCP server’s tools. See MCP.

​
Upgrading

​
Uninstall