<span id="cli-reference" />

# Справочник по CLI

`lizard` CLI — это основной интерфейс платформы. Эта страница охватывает установку, глобальные флаги, коды выхода и автоматическое обнаружение. У каждой команды есть собственная справочная страница в боковой панели — см. [`lizard up`](https://lizard.build/ru/docs/cli/up), [`lizard service`](https://lizard.build/ru/docs/cli/service), [`lizard secrets`](https://lizard.build/ru/docs/cli/secrets) и остальные.

> Справочник сгенерирован для CLI **v0.3.62**. Выполните `lizard <cmd> --help --json` для получения точной схемы, соответствующей версии, для любой команды.

<span id="install--upgrade" />

## Установка и обновление

```bash
npm install -g @lizard-build/cli
lizard --version
lizard upgrade            # update to the latest version
lizard upgrade --check    # check without installing
```

Всегда используйте глобально установленный бинарный файл `lizard` — **не** `npx`. См. [Быстрый старт](https://lizard.build/ru/docs/getting-started#1-install-the-cli) для исправления ошибок доступа.

<span id="authentication" />

## Аутентификация

```bash
lizard login                  # browser OAuth
lizard login --token lzd_xxx  # token auth
lizard logout
lizard whoami                 # current user, workspace, linked project
```

В CI задайте `LIZARD_TOKEN` в переменных окружения вместо запуска `login`.

<span id="global-flags" />

## Глобальные флаги

| Флаг | Описание |
|------|-------------|
| `-V, --version` | Вывести версию CLI |
| `--json` | Машинно-читаемый вывод. Комбинируйте с `--help`, чтобы выгрузить схему команды |

Большинство команд также принимают `-p, --project`, `-s, --service` и `-w, --workspace` для обращения к конкретному ресурсу вместо связанного.

<span id="exit-codes" />

## Коды выхода

| Код | Значение | Что делать |
|------|---------|------------|
| `0` | успех | продолжать |
| `1` | общая ошибка | прочитать сообщение |
| `2` | аутентификация (401/403) | выполните `lizard login` |
| `3` | не найдено (404) | проверьте имя с помощью `lizard ps` / `lizard project list` |
| `4` | таймаут (408/504) | повторите попытку |
| `5` | отменено пользователем | остановиться |

<span id="runtime-discovery" />

## Автоматическое обнаружение

CLI является самодокументирующимся. Чтобы увидеть полное дерево команд, глобальные флаги и коды выхода:

```bash
lizard --help --json
```

Для точных аргументов и опций любой команды или подкоманды:

```bash
lizard <cmd> --help --json
lizard <cmd> <sub> --help --json     # e.g. lizard service set --help --json
```

Это всегда отражает вашу установленную версию — используйте это вместо угадывания формата флагов. Так агент узнаёт CLI без обучения на нём: см. [развёртывание из Claude Code](https://lizard.build/blog/deploy-from-claude-code).

<span id="configuration--state" />

## Конфигурация и состояние

- CLI хранит аутентификацию и ссылку на проект текущей директории в `~/.lizard/config.json`.
- `lizard status` показывает ссылку на рабочую область/проект/сервис текущей директории (аутентификация не требуется).
- `lizard config apply` применяет файл `lizard-config.json` к проекту (используйте `--dry-run` для предварительного просмотра).

<span id="sandbox-volumes" />

## Тома Sandbox

Управляйте [Persistent Volumes](https://lizard.build/ru/docs/sandboxes/volumes) по имени в пределах проекта:

```bash
lizard volume create agent-workdir --size 10 --project proj_123
lizard volume list --project proj_123
lizard sandbox create --volume agent-workdir --project proj_123
```

Имена уникальны в проекте: строчные латинские буквы, цифры и дефисы, до 64 символов; первая и последняя позиция — буква или цифра. Новые тома принимают целые GB от 1 до 50, по умолчанию 5. CLI читает текущие ограничения сервера перед созданием тома и учитывает изменения настроек. Существующие тома большего размера сохраняют размер.

После отключения тома команда `lizard volume rm agent-workdir --project proj_123` удаляет его и данные. `volume list` показывает имена; `--json` включает сгенерированные ID.
