Skip to content
Documentation sections
Getting Started

Installation

Krythiq is a global CLI published through npm. Install it once and use it across projects on your machine. You can inspect the published package on npmx.

Prerequisites

  • Node.js 22.13 or later
  • npm, pnpm, or bun
1

Install krythiq globally

Choose your preferred package manager:

npm install -g krythiq
2

Verify the installation

Confirm krythiq was installed correctly:

krythiq --version
→ Your installed version

Build from source (optional)

CLI 0.3.0 includes doctor, report, hosted AI, and renewable connections. To use a source checkout, run these from the repository root and use node backend/dist/index.js instead of krythiq.

npm --prefix backend cinpm --prefix backend run buildnode backend/dist/index.js doctor .
3

Authenticate (optional for AI features)

AI-powered trace analysis requires an API key. Krythiq uses Anthropic Claude under the hood.

krythiq auth

You can also set ANTHROPIC_API_KEY in your environment and Krythiq will pick it up automatically.

You're ready

Head to Quick Start to run your first analysis.

Troubleshooting

EACCES: permission denied (Linux / macOS)

If you get a permissions error, configure your npm prefix to a user-writable directory:

Fix npm permissions
mkdir ~/.npm-globalnpm config set prefix '~/.npm-global'export PATH=~/.npm-global/bin:$PATH

Add the export PATH line to your ~/.zshrc or ~/.bashrc.

command not found: krythiq (after install)

Your shell may need to be reloaded after a global install:

source ~/.zshrc   # or source ~/.bashrc