quickstart

Справочник CLI для управляемой команды первого запуска apothem quickstart.

Управляемый первый запуск: обеспечить наличие профиля, просмотреть запланированные записи, затем установить.

Синтаксис

apothem quickstart [--harness NAME|all] [--project PATH] [--profile PATH]
                   [--yes] [--quiet|-q] [--verbose|-v]
                   [--format plain|json] [--json] [--no-color]

quickstart — единственная управляемая точка входа для нового оператора. В одном линейном потоке команда: (1) обеспечивает наличие общего профиля — если профиль не найден, создаёт стартовый профиль с напоминанием настроить его под себя; (2) показывает предпросмотр конкретных файлов, которые запишут выбранные окружения, сгруппированных по корню проекта и вашему домашнему каталогу; (3) запрашивает подтверждение; (4) выполняет установку со сгруппированным, очищенным от шума выводом примечаний о возможностях; и (5) печатает рекомендуемые следующие команды.

Она составлена из тех же строительных блоков, которые использует команда install, — она не реализует их заново. --project по умолчанию указывает на текущий каталог. У --harness нет значения по умолчанию: когда он не указан, quickstart спрашивает, какое окружение установить, поэтому первый запуск записывает конфигурацию одного окружения. --harness all устанавливает каждое поддерживаемое окружение и всегда является явным выбором.

Поведение

Окружение — без --harness интерактивный запуск перечисляет поддерживаемые имена (а также all) и просит выбрать одно, прежде чем что-либо будет записано. Запуск, который не может задать вопрос (--yes, --format json или отсутствие терминала), завершается ошибкой использования, в которой назван параметр --harness, и ничего не записывает.
Профиль — если по разрешённому пути профиля нет файла, quickstart предлагает создать стартовый профиль (создаёт его автоматически при --yes, в неинтерактивной оболочке или при --format json) и называет поля идентичности-заполнители, которые нужно персонализировать.
Предпросмотр и подтверждение — для --harness all цели перечисляются под двумя заголовками (корень проекта и ваш домашний каталог), а интерактивный запуск запрашивает подтверждение перед записью за пределами проекта. Одно названное окружение устанавливается без предпросмотра и запроса. --yes, неинтерактивная оболочка и --format json продолжают работу без запроса. Отказ от предпросмотра --harness all прерывает выполнение до записи установки; стартовый профиль, созданный на шаге 1, сохраняется.
Установка — возможности, которые окружение не поддерживает нативно, сводятся в одно сгруппированное примечание на каждое окружение (передайте --verbose, чтобы получить подробности по каждой возможности); полный набор всегда присутствует в массиве warnings вывода --format json.
Следующий шаг — вывод в терминале называет последующие команды (apothem verify …, apothem doctor).

Параметры

Параметр	Описание
`--harness NAME`	Адаптер окружения для установки или `all` для набора уровня всего реестра. Без значения по умолчанию: интерактивный запуск спрашивает; неинтерактивный запуск обязан его передать.
`--profile PATH`	Путь к YAML общего профиля. По умолчанию `~/.config/apothem/profile.yaml`.
`--project PATH`	Корень проекта для окружений с областью проекта. По умолчанию текущий каталог.
`--yes`	Выполнить всю управляемую последовательность неинтерактивно (пропустить каждый запрос).
`--quiet`, `-q`	Подавить информационный вывод; выводятся только ошибки.
`--verbose`, `-v`	Печатать обоснование каждой непроецированной возможности вместо сгруппированного примечания.
`--format plain\|json`	Формат вывода (по умолчанию: `plain`).
`--json`	Сокращение для `--format json`.
`--no-color`	Отключить цветовые коды ANSI в выводе.
`-h`, `--help`	Показать справку и завершить работу.

Вывод JSON

--format json выводит один документ, который подытоживает каждый управляемый шаг:

{
  "schema_version": 1,
  "status": "success",
  "command": "quickstart",
  "profile_path": "C:\\Users\\Example\\.config\\apothem\\profile.yaml",
  "steps": [
    {"step": "profile", "outcome": "created", "path": "…", "placeholder_identity": ["name", "email", "github"]},
    {"step": "install", "status": "success", "harness": "all", "files_written": ["…"], "warnings": [], "results": []},
    {"step": "recommend", "next": ["apothem verify --harness all --project .", "apothem doctor"]}
  ],
  "recommended_next": ["apothem verify --harness all --project .", "apothem doctor"]
}

Примеры

apothem quickstart                                  # asks which harness
apothem quickstart --harness claude-code --yes
apothem quickstart --harness all --project . --yes  # every harness, explicitly
apothem quickstart --harness claude-code --json

Коды выхода

Код	Значение
0	Управляемый запуск завершён
1	Ожидаемая ошибка проверки, профиля, окружения, проекта или адаптера
2	Частичная пакетная материализация после как минимум одной записи
64	Ошибка использования: неизвестный параметр или команда либо отсутствующее или недопустимое значение параметра. При `--json` ошибка представляет собой конверт JSON с кодом `cli.usage`.

См. также

apothem install — материализовать окружение из общего профиля
apothem verify — подтвердить, что установка активна
apothem doctor — состояние среды и установки
Начало работы — полное руководство по установке

quickstart

СинтаксисCopy Anchor Link

ПоведениеCopy Anchor Link

ПараметрыCopy Anchor Link

Вывод JSONCopy Anchor Link

ПримерыCopy Anchor Link

Коды выходаCopy Anchor Link

См. такжеCopy Anchor Link