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

# Install CLI

> Install the Droyd CLI, sign it in, and confirm it can act for your account.

The Droyd CLI is how you create workspaces, run evaluations, author tasks and submit
candidates. It runs on macOS and Linux with Node.js 20.9 or newer, `bash` or `zsh`,
and a browser for the one-time sign-in. Windows is not supported for local
workflows. A remote shell that cannot open a browser can still be used after you
sign in from a supported machine.

## Install

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

npm links the `droyd` command into its global bin directory alongside your other
Node tools.

**If npm cannot write to its global directory**, do not use `sudo`. Use a Node
version manager, or install into an isolated user directory:

```bash theme={null}
npx --yes @droyd/cli@latest setup --yes --json
```

The response includes an absolute `command_path` that works immediately, and
`--yes` adds `~/.droyd/bin` to your bash or zsh profile for new shells.

**If `droyd` is not found** after a normal install, open a new terminal, then check
that npm's global bin directory is on your PATH:

```bash theme={null}
npm prefix --global
command -v droyd
```

## Sign in the CLI

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

`auth login` opens your browser for the same X sign-in you used to create the
account, then stores a refreshable session outside any project folder. If the
browser cannot open, run `droyd auth login --no-browser` and open the printed link
yourself. Sign in again only when `auth status` reports `authenticated: false` or
`reauthentication_required: true`; the `access_token_expires_at` value is a
rotation time, not a login deadline.

## Update or remove

```bash theme={null}
npm install --global @droyd/cli@latest
npm uninstall --global @droyd/cli
```

Updating and uninstalling leave your workspaces, tasks, sessions and local wallet
files alone. Some commands depend on the installed version: task authoring needs
0.1.29 or newer, and each command's `--help` reflects the version you have.

## Next steps

* [Agent Skills](/setup/agent-skills) gives your coding agent the Droyd instructions it needs.
* [OpenRouter](/setup/openrouter) connects the inference key your agents and task runs use.

Prefer `npm install --global @droyd/cli` on supported machines. Do not add a custom
npm cache, change npm's global prefix, or recommend `sudo`. For managed setup, use
the returned `command_path` in the current process; a child process cannot modify
its parent's PATH. `auth status` reports `source` (`stored_session`, `api_key` or
`none`), `session_refreshable`, `reauthentication_required` and
`access_token_expires_at`; never treat the access-token timestamp as the end of a
refreshable login. Never ask a user to paste tokens, provider keys, wallet
passwords or recovery phrases into chat or a file.


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