ce-setup
everyinc/compound-engineering-plugin
Проверьте работоспособность Compound Engineering и локальные настройки репозитория.
...Расширить всеО проекте ce-setup
Легкий инструмент для проверки работоспособности и настройки локальной конфигурации репозитория для плагина Compound Engineering. Он проверяет правильность настройки среды и репозитория, сообщает о доступных дополнительных возможностях инструментов, а также очищает или обновляет файлы локальной конфигурации репозитория. Важно отметить, что он не выполняет массовую установку зависимостей: отсутствующие инструменты отображаются как дополнительные возможности, поэтому пользователь может установить только те рабочие процессы, которые он действительно использует. Он предназначен для проверки настройки, устранения неполадок, связанных с отсутствием дополнительных инструментов, или подключения репозитория.
Рабочий процесс проходит в три этапа. На этапе диагностики он определяет версию установленного плагина, если платформа её предоставляет, а затем запускает входящий в комплект скрипт проверки работоспособности (или его встроенный эквивалент). Встроенные проверки выявляют опциональные инструменты с помощью команды -v (agent-browser, gh, jq, ast-grep, ffmpeg), определяют корневую директорию репозитория с помощью git rev-parse --show-toplevel, ищут устаревший файл compound-engineering.local.md, проверяет, существует ли файл .compound-engineering/config.local.yaml и включён ли он в список gitignore, а также сравнивает пример конфигурации с прилагаемым файлом references/config-template.yaml. Отсутствие дополнительных инструментов явно не рассматривается как сбой настройки.
Вторая фаза запускается только при наличии локальной проблемы в репозитории: устаревшей локальной конфигурации Markdown, файла config.local.yaml, который не добавлен в список gitignore надлежащим образом, или отсутствующего/устаревшего примера конфигурации. Она может удалить устаревший файл, обновить файл .compound-engineering/config.local.example.yaml на основе шаблона, по желанию создать новый файл config.local.yaml (всё изначально закомментировано) и предложить добавить .compound-engineering/*.local.yaml в файл .gitignore. Каждый шаг, вносящий изменения, сопровождается блокирующим вопросом, задаваемым с помощью инструмента платформы для вопросов (AskUserQuestion в Claude Code, с задокументированными альтернативами для Codex, Antigravity и Pi), и скрипт никогда не выполняет автоматическую настройку в фоновом режиме. В итоговом сводке перечисляются примененные исправления, пропущенные исправления и любые отсутствующие дополнительные инструменты.
Часто задаваемые вопросы
Устанавливает ли этот сكيل все дополнительные зависимости за меня?
Нет. Это проверка работоспособности, а не установщик, и он намеренно избегает массовой установки зависимостей. Отсутствующие инструменты указываются как опциональные возможности, чтобы вы могли установить только те рабочие процессы, которые используете.
Какие дополнительные инструменты проверяет встроенная проверка работоспособности?
Он проверяет наличие agent-browser, gh, jq, ast-grep и ffmpeg с помощью команды -v. О любых отсутствующих инструментах сообщается, но их отсутствие не считается сбоем установки.
Когда начинается фактическое устранение неполадок?
Только при наличии локальной проблемы в репозитории: устаревшего файла compound-engineering.local.md, файла config.local.yaml, не добавленного в gitignore, или отсутствующего/устаревшего файла config.local.example.yaml. Если ни одна из этих проблем не обнаружена, выдается сообщение о завершении настройки.
Будут ли мои файлы изменены без моего разрешения?
Нет. Каждое исправление — удаление устаревшего файла конфигурации, создание локального файла конфигурации или редактирование файла .gitignore — сопровождается вопросом, требующим подтверждения, и выполняется только при вашем одобрении. Программа никогда не выполняет автоматическую настройку в фоновом режиме.
Как он исключает локальный файл конфигурации из системы контроля версий?
Если файл .compound-engineering/config.local.yaml существует, но не указан в .gitignore, программа предложит добавить .compound-engineering/*.local.yaml в .gitignore в корневом каталоге репозитория, не перезаписывая при этом не относящееся к этому содержимое.
Все файлы
3файла references/config-template.yaml 3,3КБ Просмотры scripts/check-health 5,7КБ ПросмотрыSKILL.md 5,5 КБ ПросмотрыInteraction Method
Ask each question below using the platform's blocking question tool: AskUserQuestion in Claude Code (call ToolSearch with select:AskUserQuestion first if its schema isn't loaded), request_user_input in Codex, ask_question in Antigravity CLI (agy), ask_user in Pi (requires the pi-ask-user extension). Fall back to a numbered list on the host's user-visible chat surface only when no blocking tool exists in the harness or the call errors. Never silently skip or auto-configure.
ce-setup is a lightweight health check and repo-local config helper. It does not bulk-install every optional dependency. Missing tools are reported as optional capabilities so the user can install only the workflows they use.
Artifact Root Resolution
Every Compound Engineering skill that writes or reads an artifact directory (solutions, plans, ideation, and the other CE-owned trees) resolves its root through the rule below. ce-setup carries the canonical statement and reports the resolved root so an operator can confirm where artifacts land before running other skills.
Resolve the CE artifact root <root> before composing any artifact path.
- Read
docs_rootfrom<repo-root>/.compound-engineering/config.yamlonly (<repo-root>=git rev-parse --show-toplevel). Do not read it fromconfig.local.yaml. Unset -><root>isdocs, exactly as before. - Validate a set value: a repo-relative directory whose real, symlink-resolved path stays inside the repo and is neither the repo root nor under
.git/. Otherwise stop with an error namingdocs_rootand the value -- never fall back todocs. - Use
<root>as the sole artifact location: create it if absent, compose each path as<root>/<subdir>with this skill's own subdirectory, and never also readdocs.
Phase 1: Diagnose
Step 1: Determine Plugin Version
Detect the installed compound-engineering plugin version by reading the plugin metadata or manifest when the platform exposes it. If the version cannot be determined, skip this step.
If a version is found, pass it to the check script via --version. Otherwise omit the flag.
Step 2: Run the Health Check
Before running the script, display:
Compound Engineering -- checking your environment...Run the bundled check script. Set SKILL_DIR to the absolute directory you loaded this ce-setup SKILL.md from — the Bash tool's CWD is the user's project, not the skill dir, so a bare scripts/ path will not resolve:
SKILL_DIR="<absolute path of the directory containing this SKILL.md>";if [ -f "$SKILL_DIR/scripts/check-health" ]; then bash "$SKILL_DIR/scripts/check-health" --version VERSION; else echo "Bundled health script not found at $SKILL_DIR/scripts/check-health; run the inline checks from ce-setup instead."; fi
Use the same command without --version VERSION if Step 1 could not determine a version.
If the script is unavailable, run the inline equivalent listed in references/repo-fixes.md.
Display the diagnostic output to the user. Missing optional tools are not setup failures. The health report includes the resolved artifact root and which config layer supplied it (per Artifact Root Resolution above); surface that line so the operator can confirm where CE artifacts will be written. Missing config.yaml is a reported absence, not a project issue.
Step 3: Decide Whether Fixes Are Needed
Report-gated repo-local remediations apply only to the checkout the health report diagnosed; if Phase 2 will write a different writable checkout, diagnose that checkout first, while session-level findings such as plugin version and optional tools remain from this session's Phase 1.
After the health report, decide Phase 2 from writable-checkout availability:
- If this session has a writable git checkout, run Phase 2 locally, including when
project_issuesis 0. Phase 2 always refreshes the example and always offers to createconfig.yamlwhen that file is missing. - If this session has no writable checkout, but the user named a repository and the harness exposes a remote repo-work surface with a writable checkout, run Phase 2 on that surface instead and report the remote repo-local fixes in Phase 3.
- Otherwise skip Phase 2 and go to Phase 3, saying repo-local writes were skipped because no writable checkout is available.
Also remediate these project issues when the report names them:
- obsolete
compound-engineering.local.md .compound-engineering/config.local.yamlexists but is not safely gitignored.compound-engineering/config.example.yamlis missing or outdated- the health report marks the
ce-workskill implementation engine unavailable or invalid, detects retired scalar routing keys, or reports malformed dormantwork_engine_preferences - the health report marks
docs_rootinvalid (Invalid docs_root ...) — CE artifacts will not be written until it is fixed
If optional tools are missing, do not offer a bulk install. The diagnostic already printed the relevant install command or project URL. Say: "Install optional tools only for the workflows you use."
Phase 2: Fix Repo-Local Issues
Read references/repo-fixes.md from this skill's directory before making any repo-local change. It carries Steps 4-8: removing the obsolete compound-engineering.local.md, refreshing the example config, offering to create config.yaml, repairing invalid work_engine_preferences and docs_root, and the two .gitignore offers.
All paths there resolve from the repository root (git rev-parse --show-toplevel), not the current working directory. Maintaining the generated example files is the work Phase 2 does on its own — refreshing config.example.yaml and removing the superseded config.local.example.yaml. Every change to a user-owned file is offered and applied only if the user approves.
Phase 3: Summary
User-runnable invocation rendering. In setup summaries, default to /ce-setup; use $ce-setup only when the active host is Codex or explicitly documents dollar-prefixed skill invocation. On oh-my-pi (omp), use /skill:ce-setup. Render only the invocation as inline code and output one form only.
Display a brief summary:
✅ Compound Engineering setup completeFixed: <repo-local fixes applied, or none>Skipped: <repo-local fixes declined, or none>Optional: <missing optional tools, or all available>Run `<rendered invocation>` anytime to re-check. Все файлы
0 файловУстановить ce-setup
Скачайте файлы навыков и распакуйте их в каталог .claude/skills/.
Скачать ZIPКлонируйте репозиторий и скопируйте файлы навыка в свой проект.
git clone https://github.com/EveryInc/compound-engineering-plugin/blob/main/skills/ce-setup/SKILL.md # Copy SKILL.md to your .claude/skills/ directory
Копировать





Дом
