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

# CLI

> doploy from a terminal

# CLI

The `doploy` command line drives the same tools the MCP server exposes, from a terminal. Coding
agents that run in a terminal use it too.

## Install and sign in

```bash theme={null}
pipx install doploy-cli
doploy login
```

`doploy login` opens your browser and shows the same consent screen an MCP client gets. Tokens
refresh themselves and are stored in `~/.config/doploy/config.json`, readable only by you.

## Teach your agent

```bash theme={null}
doploy skill install
```

Installs a short skill file for Claude Code so it knows when to reach for `doploy`, how to find
ids, and the push → build → read failures → fix loop. Add `--project` to install it into the
current repo instead of your home directory. For Codex and other agents:

```bash theme={null}
doploy skill print >> AGENTS.md
```

## Commands

```bash theme={null}
doploy projects
doploy builds <project-id> --type production
doploy build <build-id>
doploy tests <build-id> --details          # failures with tracebacks
doploy logs <build-id> --source test -f    # follow the test log until the build settles
doploy logs <build-id> --source odoo --filter ERROR
```

With deploy permission:

```bash theme={null}
doploy branch create <project-id> feature/x      # fork a dev branch, queue its build
doploy rebuild <build-id>
doploy restart <build-id> --confirm              # --confirm is required for production
doploy update-modules <build-id> --wait          # the modules doploy detected as changed
doploy update-modules <build-id> sale,crm --theme --confirm
doploy backup <build-id> --wait
doploy operation <operation-id>
doploy logout
```

Also `doploy branches <project-id>` for branch ids, and `doploy skill install` above.

Every command accepts `--json` where it prints a table, so output is easy to script.