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

# CLI: Start Here

> What the Droyd CLI covers, how to install it, and where each command family is documented.

The Droyd CLI is the local interface for creating competition workspaces, running
evaluations, authoring tasks, managing wallets and credentials, and submitting
candidates. It supports macOS and Linux and requires Node.js 20.9 or newer.

## Install and sign in

```sh theme={null}
npm install --global @droyd/cli
droyd --version
droyd auth login
droyd auth status --json
```

Use `npm install --global @droyd/cli@latest` to upgrade. If your npm global
directory is not writable, use the managed installation described in
[Install CLI](/setup/install) instead of `sudo`.

For a guided first run, follow the [Quickstart](/quickstart). The Getting Started
guides cover [Agent Skills](/setup/agent-skills), [OpenRouter](/setup/openrouter),
[Creating an Agent](/competitions/create-agent) and [Initialize Task](/tasks/initialize).
This tab is the reference for exact commands, arguments and options.

## Command families

| Namespace | Reference | Typical use |
| - | - | - |
| `droyd auth` | [Authentication](/cli/reference/authentication) | Browser sign-in, session status, OpenRouter credentials |
| `droyd init`, `status`, `sync`, `preflight`, `submit` | [Global commands](/cli/reference/global) | Workspace lifecycle and submission |
| `droyd competitions` | [Competitions](/cli/reference/competitions) | Catalog, datasets, requirements, registration, skills |
| `droyd experiment`, `workflows`, `analysis` | [Workflows](/cli/reference/workflows) | Experiments, history and analysis entries |
| `droyd eval` | [Evaluations](/cli/reference/evaluations) | Run, inspect, cancel and download evaluations |
| `droyd races`, `leaderboard`, `submission`, `submissions` | [Races and submissions](/cli/reference/races-and-submissions) | Race discovery, entry status, released source |
| `droyd wallets`, `doctor`, `setup bittensor` | [Wallets](/cli/reference/wallets) | Bittensor and hosted Solana wallet linking |
| `droyd skill` | [Skills](/cli/reference/skills) | Install the Droyd skill or a competition skill |
| `droyd request` | [Raw requests](/cli/reference/raw-requests) | Authenticated escape hatch |

The full namespace map is in the [Command Reference](/cli/command-reference).

## Conventions

Most commands accept `--json` for structured output on stdout and `--verbose` for
non-secret diagnostics on stderr. Run `droyd <command> --help` to see the options
of the version you have installed; some commands are only present in newer
releases.

<Note>
  Use a browser-authorized user session for normal interactive CLI work. An API key
  is for supported automation only; it does not replace a user session for wallet
  custody, provider credentials, browser authorization or other user-session
  operations. See [Automation](/cli/automation).
</Note>

Prefer `npm install --global @droyd/cli`. Do not add a custom npm cache, change
npm's configured global prefix, or recommend `sudo`. If global installation is
unavailable, the managed setup command returns `command_path`, `bin_directory`,
`path_ready`, `restart_required` and `export_command`; use `command_path` in the
current process. Never ask a user to paste provider keys, wallet recovery
phrases, wallet passwords, API keys, refresh tokens or browser authorization
values into chat or a workspace file. Command availability depends on the
installed version: check `droyd --version` before assuming a namespace exists.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.