Claron
    Documentation
    DEV
    Terminal-first    Reviewed

    Claron CLI

    A terminal-first workflow for managing annotations and applying AI fixes without leaving your editor. Registers the claron:// protocol handler so Apply Fix links can open the terminal workflow after any browser or operating-system approval.

    Install or update the CLI

    Use a current Node.js LTS runtime; The CLI requires Node.js 22 or newer. You need a terminal, package manager, and access to the repository. OS protocol registration is attempted during installation, but your OS or browser may require additional approval.

    bash
    npm install -g @claron/cli
    claron --version
    claron --help

    Authenticate and link the checkout

    For API-key authentication, use project:read for project discovery and nested project reads. Add annotation:read for top-level annotation/diff routes. Status updates on nested project routes need project:write, and POST actions need project:create. Grant only the operations you use; see API Keys.

    1. Run claron login and complete the browser sign-in, or create a scoped key in Settings → Developer & API and authenticate using claron auth

      Keep the key private.

    2. Change to the application's repository root and run claron init

      Select the matching Claron project. This writes the project link to .claron.json.

    3. Open claron ui and check its account, project link, and API status

      A project list appearing successfully does not prove that you selected the correct repository.

    4. Before applying a fix, use your normal Git workflow to commit or stash changes and check that the checkout matches the report's deployed version.

    bash
    claron login
    claron init
    claron ui

    Commands and their outcomes

    Replace <annotationId> with a real annotation UUID copied from Claron. Example commands below use an illustrative UUID; replace it before running them. Commands that open a terminal workflow are interactive, not machine-readable batch outputs.

    CommandOutcome
    claron / claron uiOpen the interactive terminal interface. Add --view, --diff or --apply with an annotation UUID to open that report directly.
    claron login / claron auth [api-key]Authenticate using browser sign-in or an API key.
    claron initChoose and link the project for this checkout.
    claron listOpen the issue list for the linked project; filter and search inside the terminal interface.
    claron view <annotationId>Open a report in the terminal interface.
    claron diff <annotationId>Open the proposed changes for review; it does not apply them.
    claron apply <annotationId>Open the fix workflow, run preflight checks, and confirm before applying.
    claron resolve <annotationId>Request or perform the permitted status change. Developer approval rules still apply.
    claron open <annotationId>Open the report in the browser.
    claron exportOpen export/settings in the terminal interface. It is not a documented --format command.
    claron backend init / doctor / uninstallEnroll, check, or remove experimental customer-backend capture; see Backend SDK.
    claron backend build / run / collectorBuild with instrumentation (required for Angular SSR), start the application with local collector recovery (run --build rebuilds first; pass your own command after --), or start/stop/check the collector.

    Review and apply a suggested fix

    1. Read the diff and check the affected files against your checkout

      Do not apply a suggestion just because it exists.

    2. Continue through the CLI's preflight and confirmation controls

      Resolve a wrong project, changed source, or missing fix before retrying.

    3. If a patch conflicts, inspect the saved .claron-conflicts/ artifacts and reconcile the changes manually.

    4. Run your application's relevant checks, commit the accepted change, and deploy it

      Local patch application does not merge a pull request or publish a deployment.

    5. Request human verification against the fixed build or deployment before treating the issue as verified.

    bash
    claron diff 00000000-0000-4000-8000-000000000001
    claron apply 00000000-0000-4000-8000-000000000001

    Dashboard handoff and recovery

    Apply Fix links can launch the registered claron:// handler and open the terminal workflow. The browser may ask permission, and registration may fail on some machines. No patch is applied merely by opening the link.

    If handoff does not launch, run claron ui --view with the issue UUID, or claron apply with that UUID, from the linked checkout. Reinstall/update the CLI if the protocol handler is absent. Check the active key and project link for Unauthorized or Project not linked errors.

    Use the help shown inside the installed terminal interface for keyboard shortcuts; shortcuts can depend on the focused panel.

    INSTALLATION & AUTH

    bash
    npm install -g @claron/cli
    claron login

    LINKING A PROJECT

    Run from your project's root directory. Saves a .claron.json file.

    bash
    claron init

    COMMAND REFERENCE

    These commands open the relevant terminal workflow. Commands such as diff and apply remain interactive and require the appropriate checks and confirmation.

    INTERACTIVE TUI

    Run claron ui (or just claron) to open the full-screen terminal UI. The current Dev Cockpit brings navigation, project context, annotation triage, and developer actions together in a keyboard-first workspace.

    Claron CLI terminal cockpit

    TUI Shortcuts

    APPLYING AI FIXES

    From terminal

    Review diffs and apply fixes directly via CLI subcommands.

    bash
    claron diff 00000000-0000-4000-8000-000000000001
    claron apply 00000000-0000-4000-8000-000000000001

    From dashboard

    Click Apply Fix on any annotation. Your OS routes the claron:// URL to the CLI when the handler is registered and your OS/browser permits it. If it does not launch, use the manual command above.