Skip to content
Carbon Docs

Install

Section titled “npm (recommended)”
Terminal window
npm install -g carbon-api

The package name is carbon-api; the primary binary is carbon (carbon-api and carbon-dev are linked as aliases). Requires Node.js 22.13 or newer.

One-liner script

Section titled “One-liner script”
Terminal window
curl -fsSL https://raw.githubusercontent.com/TaxCollector23/carbon/master/install.sh | sh

Fetches the latest published tarball and installs it into your global npm prefix.

Ephemeral

Section titled “Ephemeral”
Terminal window
npx carbon-api <command>

Verify

Section titled “Verify”
Terminal window
carbon --version
carbon doctor

carbon doctor runs a local diagnostic — Node version, pnpm, port availability on 1223/3001/4000, saved credentials, API URL, DATABASE_URL/REDIS_URL sanity, and docker presence — so you can tell right away whether the environment is ready.

Shell completion

Section titled “Shell completion”
Terminal window
carbon completion bash >> ~/.bashrc
carbon completion zsh  >  ~/.zsh/completions/_carbon
carbon completion fish >  ~/.config/fish/completions/carbon.fish