Довідник з CLI
CLI OpenSpec (openspec) надає термінальні команди для налаштування проєкту, валідації, перевірки стану та керування. Ці команди доповнюють AI-команди зі слешем (як /opsx:propose), описані в розділі Команди.
Підсумок
| Категорія | Команди | Призначення |
|---|---|---|
| Налаштування | init, update | Ініціалізація та оновлення OpenSpec у вашому проєкті |
| Робочі простори (бета) | workspace setup, workspace list, workspace ls, workspace link, workspace relink, workspace doctor, workspace open | Налаштування планування між пов'язаними репозиторіями або теками |
| Перегляд | list, view, show | Перегляд змін та специфікацій |
| Валідація | validate | Перевірка змін та специфікацій на наявність проблем |
| Життєвий цикл | archive | Завершення виконаних змін |
| Робочий процес | status, instructions, templates, schemas | Підтримка робочого процесу на основі артефактів |
| Схеми | schema init, schema fork, schema validate, schema which | Створення та керування користувацькими робочими процесами |
| Конфігурація | config | Перегляд та зміна налаштувань |
| Утиліти | feedback, completion | Зворотний зв'язок та інтеграція з оболонкою |
Команди для людей та агентів
Більшість CLI-команд призначені для використання людьми в терміналі. Деякі команди також підтримують використання агентами/скриптами через JSON-вивід.
Команди лише для людей
Ці команди є інтерактивними та призначені для використання в терміналі:
| Команда | Призначення |
|---|---|
openspec init | Ініціалізація проєкту (інтерактивні підказки) |
openspec view | Інтерактивна панель керування |
openspec config edit | Відкрити конфігурацію в редакторі |
openspec feedback | Надіслати відгук через GitHub |
openspec completion install | Встановити автодоповнення для оболонки |
Команди, сумісні з агентами
Ці команди підтримують вивід --json для програмного використання AI-агентами та скриптами:
| Команда | Використання людьми | Використання агентами |
|---|---|---|
openspec list | Перегляд змін/специфікацій | --json для структурованих даних |
openspec show <item> | Читання вмісту | --json для аналізу |
openspec validate | Перевірка наявності проблем | --all --json для масової валідації |
openspec status | Перегляд прогресу артефактів | --json для структурованого статусу |
openspec instructions | Отримання наступних кроків | --json для інструкцій агента |
openspec templates | Пошук шляхів до шаблонів | --json для визначення шляхів |
openspec schemas | Список доступних схем | --json для виявлення схем |
openspec workspace setup --no-interactive | Створення робочого простору з явними вхідними даними | --json для структурованого виводу налаштування |
openspec workspace list | Перегляд відомих робочих просторів | --json для типізованих об'єктів робочих просторів |
openspec workspace link | Прив'язка репозиторію або теки | --json для структурованого виводу прив'язки |
openspec workspace relink | Відновлення прив'язаного шляху | --json для структурованого виводу прив'язки |
openspec workspace doctor | Перевірка одного робочого простору | --json для структурованого виводу статусу |
Глобальні параметри
Ці параметри працюють з усіма командами:
| Параметр | Опис |
|---|---|
--version, -V | Показати номер версії |
--no-color | Вимкнути кольоровий вивід |
--help, -h | Показати довідку для команди |
Команди налаштування
openspec init
Ініціалізація OpenSpec у вашому проєкті. Створює структуру тек та налаштовує інтеграції з AI-інструментами.
Поведінка за замовчуванням використовує глобальні налаштування конфігурації: профіль core, доставка both, робочі процеси propose, explore, apply, sync, archive.
openspec init [path] [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
path | Ні | Цільова директорія (за замовчуванням: поточна директорія) |
Параметри:
| Параметр | Опис |
|---|---|
--tools <list> | Налаштувати AI-інструменти неінтерактивно. Використовуйте all, none або розділений комами список |
--force | Автоматичне очищення застарілих файлів без запиту |
--profile <profile> | Перевизначити глобальний профіль для цього запуску ініціалізації (core або custom) |
--profile custom використовує будь-які робочі процеси, які наразі вибрані в глобальній конфігурації (openspec config profile).
Підтримувані ID інструментів (--tools): amazon-q, antigravity, auggie, bob, claude, cline, codex, forgecode, codebuddy, continue, costrict, crush, cursor, factory, gemini, github-copilot, iflow, junie, kilocode, kimi, kiro, opencode, pi, qoder, lingma, qwen, roocode, trae, windsurf
Приклади:
bash
# Інтерактивна ініціалізація
openspec init
# Ініціалізація у вказаній директорії
openspec init ./my-project
# Неінтерактивне налаштування для Claude та Cursor
openspec init --tools claude,cursor
# Налаштування для всіх підтримуваних інструментів
openspec init --tools all
# Перевизначення профілю для цього запуску
openspec init --profile core
# Пропуск підказок та автоматичне очищення застарілих файлів
openspec init --forceЩо створюється:
openspec/
├── specs/ # Ваші специфікації (джерело істини)
├── changes/ # Запропоновані зміни
└── config.yaml # Конфігурація проєкту
.claude/skills/ # Навички Claude Code (якщо вибрано claude)
.cursor/skills/ # Навички Cursor (якщо вибрано cursor)
.cursor/commands/ # Команди OPSX для Cursor (якщо доставка включає команди)
... (інші конфігурації інструментів)openspec update
Оновлення файлів інструкцій OpenSpec після оновлення CLI. Повторно генерує файли конфігурації AI-інструментів, використовуючи ваш поточний глобальний профіль, вибрані робочі процеси та режим доставки.
openspec update [path] [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
path | Ні | Цільова директорія (за замовчуванням: поточна директорія) |
Параметри:
| Параметр | Опис |
|---|---|
--force | Примусове оновлення, навіть якщо файли актуальні |
Приклад:
bash
# Оновлення файлів інструкцій після оновлення npm
npm update @fission-ai/openspec
openspec updateКоманди робочих просторів
Команди робочих просторів знаходяться в активній розробці та ще не готові до використання. Не створюйте зовнішню автоматизацію, інтеграції або довготривалі робочі процеси на основі цих команд; поведінка команд, файли стану та JSON-вивід можуть змінитися в будь-який момент.
Координаційні робочі простори є планувальними домівками для роботи, яка охоплює кілька репозиторіїв або тек. Видимість робочого простору не є зобов'язанням до змін: прив'яжіть репозиторії або теки, які OpenSpec має знати, а потім створюйте зміни, коли будете готові планувати конкретну роботу.
openspec workspace setup
Створення робочого простору в стандартному розташуванні OpenSpec та прив'язка принаймні одного існуючого репозиторію або теки.
bash
openspec workspace setup [options]Параметри:
| Параметр | Опис |
|---|---|
--name <name> | Назва робочого простору. Назви мають бути у форматі kebab-case |
--link <path> | Прив'язати існуючий репозиторій або теку та вивести назву прив'язки з назви теки |
--link <name>=<path> | Прив'язати існуючий репозиторій або теку з явною назвою прив'язки |
--opener <id> | Зберегти бажаний відкривач під час неінтерактивного налаштування: codex, claude, github-copilot або editor |
--no-interactive | Вимкнути підказки; вимагає --name та принаймні одного --link |
--json | Вивести JSON; вимагає --no-interactive |
Приклади:
bash
openspec workspace setup
openspec workspace setup --no-interactive --name platform --link /repos/api --link web=/repos/web
openspec workspace setup --no-interactive --name platform --link /repos/api --opener codex
openspec workspace setup --no-interactive --json --name checkout --link /repos/platform/apps/checkoutІнтерактивне налаштування запитує бажаний відкривач та зберігає його в локальному стані робочого простору машини. Неінтерактивне налаштування зберігає бажаний відкривач лише тоді, коли вказано --opener; в іншому випадку workspace open запитуватиме пізніше в інтерактивних терміналах, коли доступний підтримуваний відкривач, або проситиме скрипти передати --agent <tool> або --editor.
openspec workspace list
Виведення списку відомих робочих просторів OpenSpec з локального реєстру.
bash
openspec workspace list [--json]
openspec workspace ls [--json]Список показує розташування кожного робочого простору та прив'язані репозиторії або теки. Застарілі записи реєстру повідомляються, але не змінюються.
openspec workspace link
Запис існуючого репозиторію або теки для одного робочого простору.
bash
openspec workspace link [name] <path> [options]Параметри:
| Параметр | Опис |
|---|---|
--workspace <name> | Вибрати відомий робочий простір з локального реєстру |
--json | Вивести JSON |
--no-interactive | Вимкнути підказки вибору робочого простору |
Приклади:
bash
openspec workspace link /repos/api
openspec workspace link api-service /repos/api
openspec workspace link --workspace platform /repos/platform/apps/checkoutШлях має вже існувати. Відносні шляхи вирішуються відносно поточної директорії команди перед тим, як OpenSpec зберігає підтверджений абсолютний шлях у локальному стані робочого простору машини. Прив'язані шляхи можуть бути повними репозиторіями, пакетами, сервісами, додатками або теками без локального стану openspec/ у репозиторії.
openspec workspace relink
Відновлення або зміна локального шляху для існуючої прив'язки.
bash
openspec workspace relink <name> <path> [options]Шлях має вже існувати. Relink оновлює лише локальний шлях машини для стабільної назви прив'язки.
openspec workspace doctor
Перевірка того, що один робочий простір може вирішити на поточній машині.
bash
openspec workspace doctor [options]Doctor показує розташування робочого простору, шлях планування, прив'язані репозиторії або теки, відсутні шляхи, шляхи до специфікацій локального репозиторію, якщо вони є, та пропоновані виправлення. Він повідомляє лише про проблеми; не виправляє їх автоматично.
Командам, яким потрібен один робочий простір, використовують поточний робочий простір, коли запускаються зсередини теки або підтеки робочого простору. З іншого місця передайте --workspace <name>, виберіть зі списку в інтерактивному терміналі або покладайтеся на єдиний відомий робочий простір, коли існує рівно один. У режимі --json або --no-interactive неоднозначний вибір завершується помилкою структурованого статусу та пропонує --workspace <name>.
JSON-відповіді використовують типізовані об'єкти та масиви status. Основні дані знаходяться в workspace, workspaces або link; попередження та помилки знаходяться в status.
openspec workspace open
Відкриття робочого набору робочого простору через збережений бажаний відкривач, одноразове перевизначення агента або режим редактора VS Code.
bash
openspec workspace open [name] [options]Параметри:
| Параметр | Опис |
|---|---|
--workspace <name> | Псевдонім для позиційної назви робочого простору |
--agent <tool> | Одноразове перевизначення агента: codex, claude або github-copilot |
--editor | Відкрити підтримуваний файл робочого простору VS Code як звичайний робочий простір редактора |
--no-interactive | Вимкнути підказки вибору робочого простору та відкривача |
Приклади:
bash
openspec workspace open
openspec workspace open platform
openspec workspace open platform --agent github-copilot
openspec workspace open --agent codex
openspec workspace open --editorworkspace open використовує поточний робочий простір, коли запускається всередині нього, автоматично вибирає єдиний відомий робочий простір, коли запускається з іншого місця, та просить користувача вибрати, коли відомо кілька робочих просторів. --agent та --editor не змінюють збережений бажаний відкривач. Передача обох перевизначень відкривача є помилкою; виберіть або --agent <tool>, або --editor.
OpenSpec підтримує <workspace-name>.code-workspace у корені робочого простору для відкриттів VS Code редактора та GitHub Copilot-in-VS-Code. Цей файл є локальним для машини та ігнорується за замовчуванням з конкретним записом .gitignore для <workspace-name>.code-workspace, тому створені користувачем файли *.code-workspace залишаються придатними для відстеження.
Підтримуваний робочий простір VS Code включає корінь координації як . плюс дійсні прив'язані репозиторії або теки як додаткові корені. VS Code відображає ці записи як багатокореневий робочий простір.
Відкриття кореневого робочого простору підтримує дослідження та планування через прив'язані репозиторії або теки. Редагування реалізації слід починати лише після явного запиту користувача та звичайного робочого процесу реалізації OpenSpec.
Команди перегляду
openspec list
Вивести список змін або специфікацій у вашому проєкті.
openspec list [options]Параметри:
| Параметр | Опис |
|---|---|
--specs | Вивести список специфікацій замість змін |
--changes | Вивести список змін (за замовчуванням) |
--sort <order> | Сортувати за recent (за замовчуванням) або name |
--json | Вивести у форматі JSON |
Приклади:
bash
# Вивести всі активні зміни
openspec list
# Вивести всі специфікації
openspec list --specs
# Вивід у форматі JSON для скриптів
openspec list --jsonВивід (текст):
Активні зміни:
add-dark-mode Підтримка перемикання теми інтерфейсу
fix-login-bug Обробка тайм-ауту сеансуopenspec view
Відобразити інтерактивну панель для перегляду специфікацій та змін.
openspec viewВідкриває інтерфейс на основі терміналу для навігації специфікаціями та змінами вашого проєкту.
openspec show
Відобразити деталі зміни або специфікації.
openspec show [item-name] [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
item-name | Ні | Назва зміни або специфікації (запитується, якщо пропущено) |
Параметри:
| Параметр | Опис |
|---|---|
--type <type> | Вказати тип: change або spec (визначається автоматично, якщо однозначно) |
--json | Вивести у форматі JSON |
--no-interactive | Вимкнути запити |
Параметри, специфічні для змін:
| Параметр | Опис |
|---|---|
--deltas-only | Показати лише дельта-специфікації (режим JSON) |
Параметри, специфічні для специфікацій:
| Параметр | Опис |
|---|---|
--requirements | Показати лише вимоги, виключити сценарії (режим JSON) |
--no-scenarios | Виключити вміст сценаріїв (режим JSON) |
-r, --requirement <id> | Показати конкретну вимогу за індексом (починаючи з 1) (режим JSON) |
Приклади:
bash
# Інтерактивний вибір
openspec show
# Показати конкретну зміну
openspec show add-dark-mode
# Показати конкретну специфікацію
openspec show auth --type spec
# Вивід у форматі JSON для аналізу
openspec show add-dark-mode --jsonКоманди валідації
openspec validate
Валідувати зміни та специфікації на наявність структурних проблем.
openspec validate [item-name] [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
item-name | Ні | Конкретний елемент для валідації (запитується, якщо пропущено) |
Параметри:
| Параметр | Опис |
|---|---|
--all | Валідувати всі зміни та специфікації |
--changes | Валідувати всі зміни |
--specs | Валідувати всі специфікації |
--type <type> | Вказати тип, коли назва неоднозначна: change або spec |
--strict | Увімкнути режим суворої валідації |
--json | Вивести у форматі JSON |
--concurrency <n> | Максимальна кількість паралельних валідацій (за замовчуванням: 6, або змінна середовища OPENSPEC_CONCURRENCY) |
--no-interactive | Вимкнути запити |
Приклади:
bash
# Інтерактивна валідація
openspec validate
# Валідувати конкретну зміну
openspec validate add-dark-mode
# Валідувати всі зміни
openspec validate --changes
# Валідувати все з виводом у форматі JSON (для CI/скриптів)
openspec validate --all --json
# Сувора валідація з підвищеною паралельністю
openspec validate --all --strict --concurrency 12Вивід (текст):
Валідація add-dark-mode...
✓ proposal.md валідний
✓ specs/ui/spec.md валідний
⚠ design.md: відсутній розділ "Technical Approach"
Знайдено 1 попередженняВивід (JSON):
json
{
"version": "1.0.0",
"results": {
"changes": [
{
"name": "add-dark-mode",
"valid": true,
"warnings": ["design.md: missing 'Technical Approach' section"]
}
]
},
"summary": {
"total": 1,
"valid": 1,
"invalid": 0
}
}Команди життєвого циклу
openspec archive
Архівувати завершену зміну та об'єднати дельта-специфікації в основні специфікації.
openspec archive [change-name] [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
change-name | Ні | Зміна для архівації (запитується, якщо пропущено) |
Опції:
| Опція | Опис |
|---|---|
-y, --yes | Пропустити запити на підтвердження |
--skip-specs | Пропустити оновлення специфікацій (для змін лише в інфраструктурі/інструментах/документації) |
--no-validate | Пропустити валідацію (потрібне підтвердження) |
Приклади:
bash
# Інтерактивна архівація
openspec archive
# Архівація конкретної зміни
openspec archive add-dark-mode
# Архівація без запитів (CI/скрипти)
openspec archive add-dark-mode --yes
# Архівація зміни в інструментах, яка не впливає на специфікації
openspec archive update-ci-config --skip-specsЩо вона робить:
- Валідує зміну (якщо не вказано
--no-validate) - Запитує підтвердження (якщо не вказано
--yes) - Об'єднує дельта-специфікації в
openspec/specs/ - Переміщає папку зміни до
openspec/changes/archive/YYYY-MM-DD-<name>/
Команди робочого процесу
Ці команди підтримують робочий процес OPSX, орієнтований на артефакти. Вони корисні як для людей, що перевіряють прогрес, так і для агентів, що визначають наступні кроки.
openspec status
Відобразити стан завершення артефактів для зміни.
openspec status [options]Опції:
| Опція | Опис |
|---|---|
--change <id> | Назва зміни (запитується, якщо пропущено) |
--schema <name> | Перевизначення схеми (автовизначається з конфігурації зміни) |
--json | Вивід у форматі JSON |
Приклади:
bash
# Інтерактивна перевірка статусу
openspec status
# Статус для конкретної зміни
openspec status --change add-dark-mode
# JSON для використання агентом
openspec status --change add-dark-mode --jsonВивід (текст):
Change: add-dark-mode
Schema: spec-driven
Progress: 2/4 artifacts complete
[x] proposal
[ ] design
[x] specs
[-] tasks (blocked by: design)Вивід (JSON):
json
{
"changeName": "add-dark-mode",
"schemaName": "spec-driven",
"isComplete": false,
"applyRequires": ["tasks"],
"artifacts": [
{"id": "proposal", "outputPath": "proposal.md", "status": "done"},
{"id": "design", "outputPath": "design.md", "status": "ready"},
{"id": "specs", "outputPath": "specs/**/*.md", "status": "done"},
{"id": "tasks", "outputPath": "tasks.md", "status": "blocked", "missingDeps": ["design"]}
]
}openspec instructions
Отримати збагачені інструкції для створення артефакту або застосування завдань. Використовується AI-агентами для розуміння, що створювати далі.
openspec instructions [artifact] [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
artifact | Ні | ID артефакту: proposal, specs, design, tasks або apply |
Опції:
| Опція | Опис |
|---|---|
--change <id> | Назва зміни (обов'язково в неінтерактивному режимі) |
--schema <name> | Перевизначення схеми |
--json | Вивід у форматі JSON |
Особливий випадок: Використовуйте apply як артефакт, щоб отримати інструкції з реалізації завдань.
Приклади:
bash
# Отримати інструкції для наступного артефакту
openspec instructions --change add-dark-mode
# Отримати інструкції для конкретного артефакту
openspec instructions design --change add-dark-mode
# Отримати інструкції з реалізації (apply)
openspec instructions apply --change add-dark-mode
# JSON для використання агентом
openspec instructions design --change add-dark-mode --jsonВивід включає:
- Вміст шаблону для артефакту
- Контекст проекту з конфігурації
- Вміст артефактів-залежностей
- Правила для кожного артефакту з конфігурації
openspec templates
Показати розв'язані шляхи шаблонів для всіх артефактів у схемі.
openspec templates [options]Опції:
| Опція | Опис |
|---|---|
--schema <name> | Схема для перегляду (за замовчуванням: spec-driven) |
--json | Вивід у форматі JSON |
Приклади:
bash
# Показати шляхи шаблонів для схеми за замовчуванням
openspec templates
# Показати шаблони для користувацької схеми
openspec templates --schema my-workflow
# JSON для програмного використання
openspec templates --jsonВивід (текст):
Schema: spec-driven
Templates:
proposal → ~/.openspec/schemas/spec-driven/templates/proposal.md
specs → ~/.openspec/schemas/spec-driven/templates/specs.md
design → ~/.openspec/schemas/spec-driven/templates/design.md
tasks → ~/.openspec/schemas/spec-driven/templates/tasks.mdopenspec schemas
Перелічити доступні схеми робочих процесів з їх описами та потоками артефактів.
openspec schemas [options]Опції:
| Опція | Опис |
|---|---|
--json | Вивід у форматі JSON |
Приклад:
bash
openspec schemasВивід:
Available schemas:
spec-driven (package)
The default spec-driven development workflow
Flow: proposal → specs → design → tasks
my-custom (project)
Custom workflow for this project
Flow: research → proposal → tasksКоманди схем
Команди для створення та керування користувацькими схемами робочих процесів.
openspec schema init
Створити нову локальну для проекту схему.
openspec schema init <name> [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
name | Так | Назва схеми (kebab-case) |
Опції:
| Опція | Опис |
|---|---|
--description <text> | Опис схеми |
--artifacts <list> | Розділений комами перелік ID артефактів (за замовчуванням: proposal,specs,design,tasks) |
--default | Встановити як схему проекту за замовчуванням |
--no-default | Не пропонувати встановити як схему за замовчуванням |
--force | Перезаписати існуючу схему |
--json | Вивід у форматі JSON |
Приклади:
bash
# Інтерактивне створення схеми
openspec schema init research-first
# Неінтерактивне створення з конкретними артефактами
openspec schema init rapid \
--description "Rapid iteration workflow" \
--artifacts "proposal,tasks" \
--defaultЩо вона створює:
openspec/schemas/<name>/
├── schema.yaml # Визначення схеми
└── templates/
├── proposal.md # Шаблон для кожного артефакту
├── specs.md
├── design.md
└── tasks.mdopenspec schema fork
Скопіювати існуючу схему до вашого проекту для кастомізації.
openspec schema fork <source> [name] [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
source | Так | Схема для копіювання |
name | Ні | Назва нової схеми (за замовчуванням: <source>-custom) |
Опції:
| Опція | Опис |
|---|---|
--force | Перезаписати існуюче місце призначення |
--json | Вивід у форматі JSON |
Приклад:
bash
# Скопіювати вбудовану схему spec-driven
openspec schema fork spec-driven my-workflowopenspec schema validate
Валідувати структуру та шаблони схеми.
openspec schema validate [name] [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
name | Ні | Схема для валідації (якщо пропущено, валідуються всі) |
Опції:
| Опція | Опис |
|---|---|
--verbose | Показати детальні кроки валідації |
--json | Вивід у форматі JSON |
Приклад:
bash
# Валідувати конкретну схему
openspec schema validate my-workflow
# Валідувати всі схеми
openspec schema validateopenspec schema which
Показати, звідки розв'язується схема (корисно для налагодження пріоритетів).
openspec schema which [name] [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
name | Ні | Назва схеми |
Опції:
| Опція | Опис |
|---|---|
--all | Перелічити всі схеми з їх джерелами |
--json | Вивід у форматі JSON |
Приклад:
bash
# Перевірити, звідки походить схема
openspec schema which spec-drivenВивід:
spec-driven resolves from: package
Source: /usr/local/lib/node_modules/@fission-ai/openspec/schemas/spec-drivenПріоритет схем:
- Проект:
openspec/schemas/<name>/ - Користувач:
~/.local/share/openspec/schemas/<name>/ - Пакет: Вбудовані схеми
Команди конфігурації
openspec config
Перегляд та зміна глобальної конфігурації OpenSpec.
openspec config <subcommand> [options]Підкоманди:
| Підкоманда | Опис |
|---|---|
path | Показати розташування файлу конфігурації |
list | Показати всі поточні налаштування |
get <key> | Отримати конкретне значення |
set <key> <value> | Встановити значення |
unset <key> | Видалити ключ |
reset | Скинути до значень за замовчуванням |
edit | Відкрити у $EDITOR |
profile [preset] | Інтерактивне налаштування профілю робочого процесу або через пресет |
Приклади:
bash
# Показати шлях до файлу конфігурації
openspec config path
# Показати всі налаштування
openspec config list
# Отримати конкретне значення
openspec config get telemetry.enabled
# Встановити значення
openspec config set telemetry.enabled false
# Явно встановити рядкове значення
openspec config set user.name "My Name" --string
# Видалити користувацьке налаштування
openspec config unset user.name
# Скинути всю конфігурацію
openspec config reset --all --yes
# Редагувати конфігурацію у вашому редакторі
openspec config edit
# Налаштувати профіль за допомогою майстра на основі дій
openspec config profile
# Швидкий пресет: перемикання робочих процесів на основні (зберігає режим доставки)
openspec config profile coreopenspec config profile починається з підсумку поточного стану, а потім дозволяє обрати:
- Змінити доставку + робочі процеси
- Змінити лише доставку
- Змінити лише робочі процеси
- Зберегти поточні налаштування (вихід)
Якщо ви зберігаєте поточні налаштування, зміни не записуються і пропозиція оновлення не відображається. Якщо змін конфігурації немає, але поточні файли проєкту не синхронізовані з вашим глобальним профілем/доставкою, OpenSpec покаже попередження та запропонує запустити openspec update. Натискання Ctrl+C також акуратно скасовує процес (без трасування стеку) і завершує роботу з кодом 130. У контрольному списку робочих процесів [x] означає, що робочий процес вибрано у глобальній конфігурації. Щоб застосувати ці вибори до файлів проєкту, запустіть openspec update (або оберіть Apply changes to this project now?, коли буде запропоновано всередині проєкту).
Інтерактивні приклади:
bash
# Оновлення лише доставки
openspec config profile
# обрати: Change delivery only
# обрати доставку: Skills only
# Оновлення лише робочих процесів
openspec config profile
# обрати: Change workflows only
# перемкнути робочі процеси у контрольному списку, потім підтвердитиУтилітарні команди
openspec feedback
Надіслати відгук про OpenSpec. Створює issue на GitHub.
openspec feedback <message> [options]Аргументи:
| Аргумент | Обов'язковий | Опис |
|---|---|---|
message | Так | Текст відгуку |
Параметри:
| Параметр | Опис |
|---|---|
--body <text> | Детальний опис |
Вимоги: GitHub CLI (gh) має бути встановлено та автентифіковано.
Приклад:
bash
openspec feedback "Add support for custom artifact types" \
--body "I'd like to define my own artifact types beyond the built-in ones."openspec completion
Керування автодоповненням оболонки для CLI OpenSpec.
openspec completion <subcommand> [shell]Підкоманди:
| Підкоманда | Опис |
|---|---|
generate [shell] | Вивести скрипт автодоповнення у stdout |
install [shell] | Встановити автодоповнення для вашої оболонки |
uninstall [shell] | Видалити встановлене автодоповнення |
Підтримувані оболонки: bash, zsh, fish, powershell
Приклади:
bash
# Встановити автодоповнення (автовизначення оболонки)
openspec completion install
# Встановити для конкретної оболонки
openspec completion install zsh
# Згенерувати скрипт для ручного встановлення
openspec completion generate bash > ~/.bash_completion.d/openspec
# Видалити автодоповнення
openspec completion uninstallКоди виходу
| Код | Значення |
|---|---|
0 | Успіх |
1 | Помилка (помилка валідації, відсутні файли тощо) |
Змінні середовища
| Змінна | Опис |
|---|---|
OPENSPEC_TELEMETRY | Встановіть 0, щоб вимкнути телеметрію |
DO_NOT_TRACK | Встановіть 1, щоб вимкнути телеметрію (стандартний сигнал DNT) |
OPENSPEC_CONCURRENCY | Конкурентність за замовчуванням для масової валідації (за замовчуванням: 6) |
EDITOR або VISUAL | Редактор для openspec config edit |
NO_COLOR | Вимикає кольоровий вивід, якщо встановлено |
Пов'язана документація
- Команди — AI-команди зі слешем (
/opsx:propose,/opsx:applyтощо) - Робочі процеси — Типові патерни та коли використовувати кожну команду
- Налаштування — Створення власних схем і шаблонів
- Початок роботи — Посібник з першого налаштування