Skip to content

CLI and website

Connect your terminal

Connect once to send future CLI scan results to your Krythiq dashboard. You approve the connection in your browser.

1. Start from your project

npx krythiq connect

A browser page opens and your terminal shows a short code. Keep the terminal open while you finish the next step.

2. Approve the terminal

  1. 1.Sign in to Krythiq if asked.
  2. 2.Check that the browser code matches the terminal code.
  3. 3.Select Authorize terminal.

The terminal confirms the connection and shows your available Tokens. You can close the browser tab.

3. Run a scan

npx krythiq scan .

The static scan runs locally and costs 0 Tokens. It stays in your terminal unless you choose to save it.

npx krythiq scan . --save

--save adds the result to Recent Scans in the Krythiq Web UI. Saving a static terminal scan also costs 0 Tokens and requires a connected CLI session.

Check or remove the connection

See which account is signed in and verify the session

npx krythiq whoami

This checks the saved session with Krythiq.dev and shows the account, Token balance, CLI scans, and scan Tokens used. If the session expired or was revoked, it tells you to connect again.

Check Tokens left

npx krythiq token

This performs a live balance check for the connected account. Static scans and saving them with --save remain free.

Show connection and Token balance

npx krythiq connect --status

Remove the connection from this computer

npx krythiq connect --disconnect

You can also revoke a terminal from Settings → CLI. The CLI section appears only after a terminal is connected.

Local website or remote terminal

If Krythiq is running on your computer, point the CLI to that address:

KRYTHIQ_DASHBOARD_URL=http://localhost:3000 npx krythiq connect

If the terminal cannot open a browser, print the link and open it yourself:

npx krythiq connect --no-browser