Skip to content
Apothem
Справочник CLI

Справочник CLI

Справочник CLI Apothem — краткий синтаксис, параметры и коды выхода каждой команды интерфейса командной строки apothem.

Интерфейс командной строки apothem управляет конфигурациями адаптеров окружений на основе общего профиля. Каждая страница ниже документирует одну подкоманду: её краткий синтаксис, параметры, поведение и коды выхода.

Каждая из команд install, update и uninstall также принимает псевдоним в продолженной форме (installing, updating, uninstalling), идентичный базовой команде по флагам и поведению. Обновление и удаление через каналы установки — плагин Claude Code, npx и одношаговые скрипты-установщики — задокументированы в руководствах по установке Обновление и Удаление, а не самими псевдонимами.

Команды

КомандаОписание
quickstartУправляемый первый запуск: обеспечить наличие профиля, просмотреть запланированные записи, затем установить.
installУстановить конфигурацию адаптера окружения из общего профиля (псевдоним: installing).
updateПереустановить конфигурацию адаптера окружения из текущего общего профиля (псевдоним: updating).
uninstallУдалить конфигурацию адаптера окружения (псевдоним: uninstalling).
rollbackВосстановить окружение в состояние, предшествовавшее его записанной установке.
backupsОчистить резервные копии установок и историю журнала, которые хранит Apothem (backups prune).
verifyПроверить установку адаптера окружения.
statusСообщить состояние установки, проверки и дрейфа для каждого зарегистрированного окружения.
diffПоказать ожидающие изменения конфигурации для одного окружения.
harnessesПеречислить и просмотреть зарегистрированные адаптеры окружений.
profileУправлять общим профилем Apothem.
migrate-workspaceПеренести устаревшее рабочее пространство отдельного окружения в общую структуру .apothem.
doctorЗапустить системную диагностику установки Apothem.
completionВывести скрипт автодополнения оболочки, подключаемый через source (bash, zsh, fish, powershell).

Контракт вывода JSON

Каждая команда, кроме completion (которая выводит скрипт оболочки), принимает --json (сокращение для --format json) и в этом случае записывает в stdout ровно один документ JSON. Каждый документ начинается с ключа верхнего уровня schema_version — целого числа, которое сегодня равно 1:

{"schema_version": 1, "status": "success", "command": "verify", "...": "..."}
  • Стабильность. В пределах одного schema_version изменения аддитивны: может появиться новый ключ, но ни один ключ не переименовывается и не удаляется, и ни одно значение не меняет тип. Любое другое изменение увеличивает schema_version.
  • Версионированные артефакты. profile show --json выводит сам профиль, поэтому его schema_version — это версия схемы профиля (сегодня тоже 1).
  • Одно исключение. harnesses list --json выводит массив JSON (по одному объекту на окружение), как и всегда, поэтому у него нет ключа верхнего уровня, который нёс бы версию. Обёртывание его в объект сломало бы существующие парсеры; пока это не сделает повышение версии, считайте его форму соответствующей schema_version 1.
  • Ошибки. Ожидаемые сбои используют ту же форму документа с "status": "error" и объектом error, несущим code, field, reason и fix.

Коды выхода

Каждая команда использует один и тот же небольшой набор кодов выхода; каждая страница перечисляет те, которые она может вернуть.

КодЗначение
0Успех
1Ожидаемый сбой: ошибка проверки, профиля, окружения, проекта или адаптера
2Частичный результат: пакетная операция записала или удалила что-то до сбоя (только команды, на странице которых он указан)
64Ошибка использования: неизвестный параметр или команда, отсутствующий обязательный параметр или недопустимое значение параметра

Ошибка использования никогда не затрагивает файловую систему. При --json (или --format json) она печатает один документ ошибки с "code": "cli.usage" вместо обычного текста справки по использованию, чтобы автоматизация могла отличить опечатку во флаге от частичной записи.

Для slash-команд и обзора CLI более высокого уровня см. справочные страницы Обзор CLI и Slash-команды.

On this page