> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comet.rpamis.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI quickstart

> Get Comet running with three commands: init, status, and doctor. New users start here.

This page is the shortest onboarding path for the Comet CLI. Just three commands cover installation, checking, and recovery. For the full options of each command, see the [advanced topics](#advanced-topics).

## Prerequisites

* Node.js 20+
* npm/npx
* Git

<Info>
  Since 0.4.0-beta.1, Comet is a pure Node runtime and no longer requires Bash, Git Bash, or WSL. macOS, Linux, and Windows use the same set of commands.
</Info>

## Step 1: Install Comet

Install the CLI globally:

```bash theme={null}
npm install -g @rpamis/comet
```

## Step 2: Initialize the project

Run it in the project root:

```bash theme={null}
comet init
```

It detects your AI coding platform and installs OpenSpec, Superpowers, and Comet Skills. For a Chinese-language environment, we recommend:

```bash theme={null}
comet init --scope project --language zh
```

For CI or scripting environments, use non-interactive mode:

```bash theme={null}
comet init --yes --scope project --language zh --json
```

<Tip>
  After initialization, we recommend running `comet doctor` once to confirm the installation is complete.
</Tip>

## Step 3: Use these two commands day to day

### Recovering your workflow: comet status

After a session is interrupted, check the status before continuing:

```bash theme={null}
comet status
```

It tells you the current active change, which phase it's in, and the recommended next command. Then type `/comet` to continue — the Agent recovers from file state, not from memory.

### Troubleshooting: comet doctor

If `comet status` shows something abnormal, or the installation looks off:

```bash theme={null}
comet doctor
```

It checks both project-level and global installations, platform directories, Skills, scripts, and active change status, and provides recovery hints.

## Upgrade and uninstall

Upgrade to the latest version:

```bash theme={null}
npm install -g @rpamis/comet@latest
comet update --scope project --language zh
comet doctor
```

Uninstall (preserving your OpenSpec changes, design documents, and code):

```bash theme={null}
comet uninstall --scope project
```

## FAQ

<Accordion title="Where does comet init install to?">
  By default it detects the AI coding platform directories in the current project. Use `--scope project` for project-level only, or `--scope global` for a global install.
</Accordion>

<Accordion title="status shows the wrong phase">
  Run `comet doctor` first to check for a malformed `.comet.yaml` or missing evidence. After fixing, re-run status.
</Accordion>

<Accordion title="Do scripts run on Windows?">
  Since 0.4.0-beta.1, all scripts run through Node.js, so Windows no longer requires Git Bash or WSL.
</Accordion>

## Advanced topics

The basic path ends here. Below are the full command references grouped by scenario:

| Advanced topic                       | Suited for                                          |
| ------------------------------------ | --------------------------------------------------- |
| [comet init](/en/cli/init)           | Full initialization options and component selection |
| [comet status](/en/cli/status)       | Full status fields and runtime data                 |
| [comet dashboard](/en/cli/dashboard) | Local read-only browser dashboard                   |
| [comet doctor](/en/cli/doctor)       | Full diagnostic scope and troubleshooting flow      |
| [comet update](/en/cli/update)       | Upgrade flow and language switching                 |
| [comet uninstall](/en/cli/uninstall) | Safe uninstall and scope control                    |

### Skill, evaluation, and publishing commands

These three groups of commands belong to advanced scenarios. Regular users typically use them indirectly through `/comet-any`:

| Advanced topic                   | Suited for                                             |
| -------------------------------- | ------------------------------------------------------ |
| [comet skill](/en/cli/skill)     | Local Skill package management and advanced Skill runs |
| [comet eval](/en/cli/eval)       | General-purpose Skill evaluation entry point           |
| [comet publish](/en/cli/publish) | Skill publishing and distribution                      |
| [comet bundle](/en/cli/bundle)   | Advanced Bundle backend (auditing/debugging)           |

To create reusable Skills, start with [Composing any Skill quickstart](/en/skill-creator/getting-started); to evaluate Skills, start with [Evaluation quickstart](/en/eval/quickstart).