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, — он не переопределяет их. По умолчанию --harness равно all, а --project — текущий каталог.

Поведение

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

Параметры

Параметр	Описание
`--harness NAME`	Адаптер ассистента по написанию кода для установки или `all` для набора уровня всего реестра (по умолчанию: `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 выдаёт единый документ, суммирующий каждый управляемый шаг:

{
  "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
apothem quickstart --harness all --project . --yes
apothem quickstart --harness claude-code
apothem quickstart --json

Коды выхода

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

См. также

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