Skip to content
Docs menu

Installation

Kratex is a single npm package. Requires Node.js 18.17 or later.

Install

npm install -g @kratex/cli

Verify

kratex --version

That confirms the binary is installed and resolvable on your PATH. For a fuller health check, run kratex doctor. It reports the kratex, Node, and npm versions, the resolved policy file (or the built-in default when no kratex.policy.json is found), and a summary of the active policy. If your Node version is below the 18.17 floor, it says so and exits non-zero.

Update

npm update -g @kratex/cli

Troubleshooting

kratex: command not found means your shell can’t find the global binary: Kratex installed, but npm’s global bin directory isn’t on your PATH. Print npm’s global prefix with npm prefix -g (the binary lives in that directory’s bin), make sure that path is on your PATH, and reload your shell. If you use a Node version manager like nvm, fnm, or Volta, confirm you installed into the Node version you currently have active.

Next step

Quickstart: run your first command under Kratex and see a block in action.