Корневой CLI CodeGraph работает из source checkout. В корне репозитория используйте:
python -m src.cli --help
Не считайте, что установка Python wheel создаёт executable codegraph. Текущий
pyproject.toml публикует только консольные entry points codegraph-acp и codegraph-lsp.
В конкретном развёртывании может быть операторская обёртка; до применения проверьте её
собственной командой --help.
Форма команды
Каноническая форма для source checkout:
python -m src.cli <command> [subcommand] [options]
Проверяйте help на нужном уровне:
python -m src.cli import --help
python -m src.cli projects --help
python -m src.cli audit --help
python -m src.cli review --help
python -m src.cli doctor --help
Help установленной версии — авторитетный источник flags и допустимых значений. Retired alias и параметры, отсутствующие в help, не входят в текущий контракт.
Безопасные первые команды
До мутаций соберите диагностику:
python -m src.cli doctor --json
python -m src.cli projects list
python -m src.cli languages
Для project-specific операции передайте или разрешите явный project scope. Не полагайтесь на необъяснённый active-project fallback и не передавайте raw storage path через agent-facing интерфейсы.
Типовые задачи
| Задача | Начальная команда | Что сохранить |
|---|---|---|
| Импорт репозитория | python -m src.cli import --help |
resolved source, project identity, job status |
| Проверка project scope | python -m src.cli projects info <name> |
tenant/group/project и freshness |
| Аудит проекта | python -m src.cli audit --help |
options, revision и findings artifact |
| Review изменений | python -m src.cli review --help |
base ref, target ref и source locations |
| Диагностика runtime | python -m src.cli doctor --json |
diagnostic JSON до repair |
| Формирование SBOM | python -m src.cli sbom --help |
project revision, format и digest результата |
Полный цикл импорта описан в руководстве по импорту, режимы аудита и состав evidence — в аудите проекта на основе CPG, а восстановление — в диагностике.
Поиск цели и предпросмотр diff
Текущая edit-поверхность поддерживает find and preview only:
python -m src.cli edit find <pattern> --file PATH
python -m src.cli edit preview file.py::name --new-code-file PATH
find ищет цели в поддерживаемых исходниках. preview читает цель и предлагаемый replacement и
печатает diff, не записывая исходный файл. Зарегистрированные apply, undo, and history пока
not yet implemented и возвращают код 1. Публичного REST- или MCP-маршрута редактирования нет.
Применяйте принятое изменение через управляемую реализацию с тестами, review и rollback; preview
показывает планируемую мутацию, а запись результата подтверждает её выполнение.
Жизненный цикл service account
Администратор может проверить поддерживаемый процесс machine identity по текущему parser:
python -m src.cli auth service-account --help
python -m src.cli auth service-account create --help
python -m src.cli auth service-account list --help
python -m src.cli auth service-account inspect --help
python -m src.cli auth service-account rotate --help
python -m src.cli auth service-account revoke --help
python -m src.cli auth service-account deactivate --help
Считайте credential из create или rotate одноразовым чувствительным результатом. Назначайте
только необходимые actions и project scope, сохраняйте в evidence identity credential, но не его
секрет. До закрытия запроса на отзыв доступа проверьте revoke или deactivate. Границы
authorization и mTLS описаны в RBAC.
Снимки прослеживаемости
Dashboard CLI предоставляет текущий lifecycle снимков:
python -m src.cli dashboard snapshot --help
python -m src.cli dashboard snapshot show --help
python -m src.cli dashboard snapshot policy --help
Команда show возвращает immutable metadata, а policy — правила управления установленной
версии. List, compare и export доступны в том же help. Операции delete нет: release- и
portfolio-evidence должны сохранять identity снимка. Подробнее — в
справочнике снимков.
Автоматизация
- Фиксируйте релиз CodeGraph и revision репозитория.
- Для compatibility check вызывайте
--help, не копируйте замороженный inventory команд. - Для долговечных артефактов задавайте явный output path.
- Ненулевой exit status показывает невыполненный operational postcondition; product acceptance verdict фиксируется отдельным решением.
- Храните токены и пароли в одобренном secret mechanism, не в аргументах и логах.
Источники контракта
src/cli/__main__.py— текущий root parser и регистрация команд;src/cli/core_commands/— parsers импорта и проектов;src/cli/core_commands/auth_commands.py— lifecycle service account;src/cli/dashboard_suite/dashboard_command_registration.py— команды снимков;src/cli/governance_suite/doctor_commands.py— diagnostic surface;src/cli/docs_suite/edit_commands.py— поддерживаемые поиск/preview и явные stateful stubs;pyproject.toml— установочные entry pointscodegraph-acpиcodegraph-lsp.
См. также: Краткий справочник · OpenCode quick start