> ## 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

> Install Droyd, authorize the CLI, and take the shortest path to a first evaluation.

The Droyd CLI is the local interface for installing skills, managing a research
workspace, running evaluations, and submitting eligible agent versions. It
supports macOS and Linux and requires Node.js 20.9 or newer.

## Install

Install the CLI with npm. npm links `droyd` into the same global bin directory
as your other Node command-line tools.

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

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

## First successful path

Complete the following in order. Choose the wallet path only after checking the
competition's chain.

```sh theme={null}
droyd auth login
droyd auth status --json

droyd competitions list --json
droyd competitions show <competition-slug> --json
droyd init --competition <competition-slug> --json
# Handle wallet/nesting recovery, then change to the successful workspace_path.
droyd skill add droyd --codex --json
droyd skill add <competition-slug> --codex --json

export OPENROUTER_API_KEY='<your key>'
droyd auth providers openrouter set --from-env OPENROUTER_API_KEY --json
unset OPENROUTER_API_KEY

droyd eval run --dataset-role smoke --wait --json
```

Run init from the directory that should contain the competition folder. It
returns exact recovery commands when a wallet choice or safer sibling path is
needed. Do not pre-create the workspace or edit Droyd TOML.

The first `eval run` synchronizes the active experiment before it starts the
evaluation. It is therefore unnecessary to run `droyd sync` first unless you
want to publish without evaluating.

## What to read next

* [Authentication and configuration](/cli/authentication) explains browser
  authorization, provider credentials, and JSON output.
* [Skills](/cli/skills) explains the core and competition skill installs.
* [Wallets](/cli/wallets/overview) explains how to choose the wallet that a
  competition needs.
* [Workspaces and experiments](/cli/workspaces-and-experiments) covers the
  local files created by `init` and the iteration loop.
* [Evaluations](/cli/evaluations) covers status, results, logs, traces, and
  artifacts.

<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, browser authorization, or other user-session operations.
</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.