Referência da CLI
A CLI do OpenSpec (openspec) fornece comandos de terminal para configuração do projeto, validação, inspeção de status e gerenciamento. Esses comandos complementam os comandos de barra da IA (como /opsx:propose) documentados em Commands.
Resumo
| Categoria | Comandos | Finalidade |
|---|---|---|
| Configuração | init, update | Inicializar e atualizar o OpenSpec em seu projeto |
| Workspaces (beta) | workspace setup, workspace list, workspace ls, workspace link, workspace relink, workspace doctor, workspace open | Configurar planejamento entre repositórios ou pastas vinculadas |
| Navegação | list, view, show | Explorar alterações e especificações |
| Validação | validate | Verificar alterações e especificações em busca de problemas |
| Ciclo de vida | archive | Finalizar alterações concluídas |
| Fluxo de trabalho | status, instructions, templates, schemas | Suporte a fluxo de trabalho orientado por artefatos |
| Schemas | schema init, schema fork, schema validate, schema which | Criar e gerenciar fluxos de trabalho personalizados |
| Configuração | config | Visualizar e modificar configurações |
| Utilitários | feedback, completion | Feedback e integração com o shell |
Comandos Humanos vs. de Agente
A maioria dos comandos CLI são projetados para uso humano em um terminal. Alguns comandos também suportam uso por agentes/scripts através de saída JSON.
Comandos Apenas para Humanos
Esses comandos são interativos e projetados para uso em terminal:
| Comando | Finalidade |
|---|---|
openspec init | Inicializar projeto (prompts interativos) |
openspec view | Painel de controle interativo |
openspec config edit | Abrir configuração no editor |
openspec feedback | Enviar feedback via GitHub |
openspec completion install | Instalar completions de shell |
Comandos Compatíveis com Agentes
Esses comandos suportam saída --json para uso programático por agentes de IA e scripts:
| Comando | Uso Humano | Uso por Agente |
|---|---|---|
openspec list | Navegar por alterações/especificações | --json para dados estruturados |
openspec show <item> | Ler conteúdo | --json para análise |
openspec validate | Verificar problemas | --all --json para validação em massa |
openspec status | Ver progresso dos artefatos | --json para status estruturado |
openspec instructions | Obter próximos passos | --json para instruções do agente |
openspec templates | Encontrar caminhos de templates | --json para resolução de caminhos |
openspec schemas | Listar schemas disponíveis | --json para descoberta de schemas |
openspec workspace setup --no-interactive | Criar um espaço de trabalho com entradas explícitas | --json para saída de setup estruturada |
openspec workspace list | Navegar por espaços de trabalho conhecidos | --json para objetos de espaço de trabalho tipados |
openspec workspace link | Vincular um repositório ou pasta | --json para saída de vinculação estruturada |
openspec workspace relink | Reparar um caminho vinculado | --json para saída de vinculação estruturada |
openspec workspace doctor | Verificar um espaço de trabalho | --json para saída de status estruturada |
Opções Globais
Essas opções funcionam com todos os comandos:
| Opção | Descrição |
|---|---|
--version, -V | Exibir número da versão |
--no-color | Desabilitar saída colorida |
--help, -h | Exibir ajuda para o comando |
Comandos de Setup
openspec init
Inicializar o OpenSpec em seu projeto. Cria a estrutura de pastas e configura as integrações de ferramentas de IA.
O comportamento padrão usa os padrões da configuração global: perfil core, entrega both, workflows propose, explore, apply, sync, archive.
openspec init [caminho] [opções]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
caminho | Não | Diretório de destino (padrão: diretório atual) |
Opções:
| Opção | Descrição |
|---|---|
--tools <lista> | Configurar ferramentas de IA de forma não interativa. Use all, none ou uma lista separada por vírgulas |
--force | Limpar automaticamente arquivos legados sem solicitar confirmação |
--profile <perfil> | Sobrescrever o perfil global para esta execução do init (core ou custom) |
--profile custom usa quaisquer workflows que estejam atualmente selecionados na configuração global (openspec config profile).
IDs de ferramentas suportadas (--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
Exemplos:
bash
# Inicialização interativa
openspec init
# Inicializar em um diretório específico
openspec init ./meu-projeto
# Não interativo: configurar para Claude e Cursor
openspec init --tools claude,cursor
# Configurar para todas as ferramentas suportadas
openspec init --tools all
# Sobrescrever perfil para esta execução
openspec init --profile core
# Pular prompts e limpar automaticamente arquivos legados
openspec init --forceO que ele cria:
openspec/
├── specs/ # Suas especificações (fonte da verdade)
├── changes/ # Alterações propostas
└── config.yaml # Configuração do projeto
.claude/skills/ # Habilidades do Claude Code (se claude selecionado)
.cursor/skills/ # Habilidades do Cursor (se cursor selecionado)
.cursor/commands/ # Comandos OPSX do Cursor (se a entrega incluir comandos)
... (outras configurações de ferramentas)openspec update
Atualizar os arquivos de instrução do OpenSpec após atualizar a CLI. Re-gera os arquivos de configuração das ferramentas de IA usando seu perfil global atual, workflows selecionados e modo de entrega.
openspec update [caminho] [opções]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
caminho | Não | Diretório de destino (padrão: diretório atual) |
Opções:
| Opção | Descrição |
|---|---|
--force | Forçar atualização mesmo quando os arquivos estiverem atualizados |
Exemplo:
bash
# Atualizar arquivos de instrução após atualização via npm
npm update @fission-ai/openspec
openspec updateComandos de Espaço de Trabalho
Os comandos de espaço de trabalho estão em desenvolvimento ativo e ainda não estão prontos para uso. Não construa automações externas, integrações ou workflows de longa duração sobre essa superfície de comandos; o comportamento dos comandos, arquivos de estado e saída JSON podem mudar a qualquer momento.
Espaços de trabalho de coordenação são locais de planejamento para trabalho que abrange múltiplos repositórios ou pastas. A visibilidade do espaço de trabalho não é um compromisso de alteração: vincule os repositórios ou pastas que o OpenSpec deve conhecer, depois crie alterações quando estiver pronto para planejar um trabalho específico.
openspec workspace setup
Criar um espaço de trabalho no local padrão do OpenSpec e vincular pelo menos um repositório ou pasta existente.
bash
openspec workspace setup [opções]Opções:
| Opção | Descrição |
|---|---|
--name <nome> | Nome do espaço de trabalho. Nomes devem estar em kebab-case |
--link <caminho> | Vincular um repositório ou pasta existente e inferir o nome do link a partir do nome da pasta |
--link <nome>=<caminho> | Vincular um repositório ou pasta existente com um nome de link explícito |
--opener <id> | Armazenar um abridor preferido durante o setup não interativo: codex, claude, github-copilot ou editor |
--no-interactive | Desabilitar prompts; requer --name e pelo menos um --link |
--json | Saída JSON; requer --no-interactive |
Exemplos:
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/checkoutO setup interativo solicita um abridor preferido e o armazena no estado local da máquina do espaço de trabalho. O setup não interativo armazena um abridor preferido apenas quando --opener é fornecido; caso contrário, workspace open solicitará mais tarde em terminais interativos quando um abridor suportado estiver disponível, ou pedirá que os scripts passem --agent <ferramenta> ou --editor.
openspec workspace list
Listar os espaços de trabalho OpenSpec conhecidos a partir do registro local.
bash
openspec workspace list [--json]
openspec workspace ls [--json]A lista mostra a localização de cada espaço de trabalho e os repositórios ou pastas vinculados. Registros obsoletos no registro são reportados, mas não alterados.
openspec workspace link
Registrar um repositório ou pasta existente para um espaço de trabalho.
bash
openspec workspace link [nome] <caminho> [opções]Opções:
| Opção | Descrição |
|---|---|
--workspace <nome> | Selecionar um espaço de trabalho conhecido do registro local |
--json | Saída JSON |
--no-interactive | Desabilitar prompts de seleção de espaço de trabalho |
Exemplos:
bash
openspec workspace link /repos/api
openspec workspace link api-service /repos/api
openspec workspace link --workspace platform /repos/platform/apps/checkoutO caminho deve já existir. Caminhos relativos são resolvidos em relação ao diretório atual do comando antes que o OpenSpec armazene o caminho absoluto verificado no estado local da máquina do espaço de trabalho. Caminhos vinculados podem ser repositórios completos, pacotes, serviços, aplicativos ou pastas sem estado openspec/ local no repositório.
openspec workspace relink
Reparar ou alterar o caminho local para um link existente.
bash
openspec workspace relink <nome> <caminho> [opções]O caminho deve já existir. Relink atualiza apenas o caminho local da máquina para o nome de link estável.
openspec workspace doctor
Verificar o que um espaço de trabalho pode resolver na máquina atual.
bash
openspec workspace doctor [opções]Doctor mostra a localização do espaço de trabalho, caminho de planejamento, repositórios ou pastas vinculados, caminhos ausentes, caminhos de especificações locais do repositório quando presentes e correções sugeridas. Ele reporta apenas problemas; não os repara automaticamente.
Comandos que precisam de um espaço de trabalho usam o espaço de trabalho atual quando executados de dentro de uma pasta ou subdiretório do espaço de trabalho. De outro lugar, passe --workspace <nome>, selecione a partir do seletor em um terminal interativo, ou confie no único espaço de trabalho conhecido quando exatamente um existir. No modo --json ou --no-interactive, uma seleção ambígua falha com um erro de status estruturado e sugere --workspace <nome>.
Respostas JSON usam objetos tipados mais arrays status. Os dados primários ficam em workspace, workspaces ou link; avisos e erros ficam em status.
openspec workspace open
Abrir um conjunto de trabalho do espaço de trabalho através do abridor preferido armazenado, uma substituição de agente para uma sessão, ou o modo editor do VS Code.
bash
openspec workspace open [nome] [opções]Opções:
| Opção | Descrição |
|---|---|
--workspace <nome> | Alias para o nome posicional do espaço de trabalho |
--agent <ferramenta> | Substituição de agente para uma sessão: codex, claude ou github-copilot |
--editor | Abrir o arquivo de espaço de trabalho VS Code mantido como um espaço de trabalho de editor normal |
--no-interactive | Desabilitar prompts de seleção de espaço de trabalho e abridor |
Exemplos:
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 usa o espaço de trabalho atual quando executado dentro de um, seleciona automaticamente o único espaço de trabalho conhecido quando executado em outro lugar, e pede ao usuário para escolher quando múltiplos espaços de trabalho são conhecidos. --agent e --editor não alteram o abridor preferido armazenado. Passar ambas as substituições de abridor é um erro; escolha --agent <ferramenta> ou --editor.
O OpenSpec mantém <nome-do-espaco-de-trabalho>.code-workspace na raiz do espaço de trabalho para aberturas no editor VS Code e no GitHub Copilot-in-VS-Code. Esse arquivo é local da máquina e ignorado por padrão com uma entrada específica <nome-do-espaco-de-trabalho>.code-workspace no .gitignore, para que os arquivos *.code-workspace criados pelo usuário permaneçam elegíveis para rastreamento.
O espaço de trabalho VS Code mantido inclui a raiz de coordenação como . mais repositórios ou pastas vinculados válidos como raízes adicionais. O VS Code exibe essas entradas como um espaço de trabalho multi-raiz.
A abertura do espaço de trabalho raiz suporta exploração e planejamento através dos repositórios ou pastas vinculados. Edições de implementação devem começar apenas após uma solicitação explícita do usuário e um fluxo de trabalho normal de implementação do OpenSpec.
Comandos de Navegação
openspec list
Lista alterações ou especificações no seu projeto.
openspec list [opções]Opções:
| Opção | Descrição |
|---|---|
--specs | Lista especificações em vez de alterações |
--changes | Lista alterações (padrão) |
--sort <ordem> | Ordena por recent (padrão) ou name |
--json | Saída em formato JSON |
Exemplos:
bash
# Lista todas as alterações ativas
openspec list
# Lista todas as especificações
openspec list --specs
# Saída JSON para scripts
openspec list --jsonSaída (texto):
Alterações ativas:
add-dark-mode Suporte a troca de tema da interface
fix-login-bug Tratamento de timeout de sessãoopenspec view
Exibe um painel interativo para explorar especificações e alterações.
openspec viewAbre uma interface baseada em terminal para navegar pelas especificações e alterações do seu projeto.
openspec show
Exibe detalhes de uma alteração ou especificação.
openspec show [nome-do-item] [opções]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
nome-do-item | Não | Nome da alteração ou especificação (solicita se omitido) |
Opções:
| Opção | Descrição |
|---|---|
--type <tipo> | Especifica o tipo: change ou spec (detectado automaticamente se não ambíguo) |
--json | Saída em formato JSON |
--no-interactive | Desativa prompts |
Opções específicas para alterações:
| Opção | Descrição |
|---|---|
--deltas-only | Mostra apenas especificações delta (modo JSON) |
Opções específicas para especificações:
| Opção | Descrição |
|---|---|
--requirements | Mostra apenas requisitos, exclui cenários (modo JSON) |
--no-scenarios | Exclui conteúdo de cenários (modo JSON) |
-r, --requirement <id> | Mostra requisito específico pelo índice baseado em 1 (modo JSON) |
Exemplos:
bash
# Seleção interativa
openspec show
# Mostra uma alteração específica
openspec show add-dark-mode
# Mostra uma especificação específica
openspec show auth --type spec
# Saída JSON para análise
openspec show add-dark-mode --jsonComandos de Validação
openspec validate
Valida alterações e especificações quanto a problemas estruturais.
openspec validate [nome-do-item] [opções]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
nome-do-item | Não | Item específico para validar (solicita se omitido) |
Opções:
| Opção | Descrição |
|---|---|
--all | Valida todas as alterações e especificações |
--changes | Valida todas as alterações |
--specs | Valida todas as especificações |
--type <tipo> | Especifica o tipo quando o nome é ambíguo: change ou spec |
--strict | Ativa modo de validação estrita |
--json | Saída em formato JSON |
--concurrency <n> | Máximo de validações paralelas (padrão: 6, ou variável de ambiente OPENSPEC_CONCURRENCY) |
--no-interactive | Desativa prompts |
Exemplos:
bash
# Validação interativa
openspec validate
# Valida uma alteração específica
openspec validate add-dark-mode
# Valida todas as alterações
openspec validate --changes
# Valida tudo com saída JSON (para CI/scripts)
openspec validate --all --json
# Validação estrita com paralelismo aumentado
openspec validate --all --strict --concurrency 12Saída (texto):
Validando add-dark-mode...
✓ proposal.md válido
✓ specs/ui/spec.md válido
⚠ design.md: seção "Technical Approach" ausente
1 aviso encontradoSaída (JSON):
json
{
"version": "1.0.0",
"results": {
"changes": [
{
"name": "add-dark-mode",
"valid": true,
"warnings": ["design.md: seção 'Technical Approach' ausente"]
}
]
},
"summary": {
"total": 1,
"valid": 1,
"invalid": 0
}
}Comandos de Ciclo de Vida
openspec archive
Arquiva uma alteração concluída e mescla as especificações delta nas especificações principais.
openspec archive [change-name] [options]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
change-name | Não | Alteração a ser arquivada (solicita se omitido) |
Opções:
| Opção | Descrição |
|---|---|
-y, --yes | Pula as confirmações interativas |
--skip-specs | Pula atualizações de especificações (para alterações apenas de infraestrutura/ferramentas/documentação) |
--no-validate | Pula a validação (requer confirmação) |
Exemplos:
bash
# Arquivamento interativo
openspec archive
# Arquiva uma alteração específica
openspec archive add-dark-mode
# Arquiva sem prompts (CI/scripts)
openspec archive add-dark-mode --yes
# Arquiva uma alteração de ferramentas que não afeta as especificações
openspec archive update-ci-config --skip-specsO que ele faz:
- Valida a alteração (a menos que
--no-validate) - Solicita confirmação (a menos que
--yes) - Mescla as especificações delta em
openspec/specs/ - Move a pasta da alteração para
openspec/changes/archive/YYYY-MM-DD-<nome>/
Comandos de Fluxo de Trabalho
Esses comandos suportam o fluxo de trabalho OPSX orientado a artefatos. Eles são úteis tanto para humanos verificando o progresso quanto para agentes determinando os próximos passos.
openspec status
Exibe o status de conclusão dos artefatos de uma alteração.
openspec status [options]Opções:
| Opção | Descrição |
|---|---|
--change <id> | Nome da alteração (solicita se omitido) |
--schema <name> | Substituição de esquema (detectado automaticamente a partir da config da alteração) |
--json | Saída como JSON |
Exemplos:
bash
# Verificação de status interativa
openspec status
# Status para uma alteração específica
openspec status --change add-dark-mode
# JSON para uso por agentes
openspec status --change add-dark-mode --jsonSaída (texto):
Change: add-dark-mode
Schema: spec-driven
Progress: 2/4 artifacts complete
[x] proposal
[ ] design
[x] specs
[-] tasks (blocked by: design)Saída (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
Obtém instruções enriquecidas para criar um artefato ou aplicar tarefas. Usado por agentes de IA para entender o que criar em seguida.
openspec instructions [artifact] [options]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
artifact | Não | ID do artefato: proposal, specs, design, tasks ou apply |
Opções:
| Opção | Descrição |
|---|---|
--change <id> | Nome da alteração (obrigatório no modo não interativo) |
--schema <name> | Substituição de esquema |
--json | Saída como JSON |
Caso especial: Use apply como artefato para obter instruções de implementação de tarefas.
Exemplos:
bash
# Obtém instruções para o próximo artefato
openspec instructions --change add-dark-mode
# Obtém instruções para um artefato específico
openspec instructions design --change add-dark-mode
# Obtém instruções de aplicação/implementação
openspec instructions apply --change add-dark-mode
# JSON para consumo por agentes
openspec instructions design --change add-dark-mode --jsonA saída inclui:
- Conteúdo do modelo para o artefato
- Contexto do projeto a partir da configuração
- Conteúdo dos artefatos de dependência
- Regras por artefato da configuração
openspec templates
Mostra os caminhos resolvidos dos modelos para todos os artefatos em um esquema.
openspec templates [options]Opções:
| Opção | Descrição |
|---|---|
--schema <name> | Esquema a ser inspecionado (padrão: spec-driven) |
--json | Saída como JSON |
Exemplos:
bash
# Mostra caminhos dos modelos para o esquema padrão
openspec templates
# Mostra modelos para um esquema personalizado
openspec templates --schema my-workflow
# JSON para uso programático
openspec templates --jsonSaída (texto):
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
Lista os esquemas de fluxo de trabalho disponíveis com suas descrições e fluxos de artefatos.
openspec schemas [options]Opções:
| Opção | Descrição |
|---|---|
--json | Saída como JSON |
Exemplo:
bash
openspec schemasSaída:
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 → tasksComandos de Esquema
Comandos para criar e gerenciar esquemas de fluxo de trabalho personalizados.
openspec schema init
Cria um novo esquema local do projeto.
openspec schema init <name> [options]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
name | Sim | Nome do esquema (kebab-case) |
Opções:
| Opção | Descrição |
|---|---|
--description <text> | Descrição do esquema |
--artifacts <list> | IDs dos artefatos separados por vírgula (padrão: proposal,specs,design,tasks) |
--default | Define como esquema padrão do projeto |
--no-default | Não solicita para definir como padrão |
--force | Sobrescreve um esquema existente |
--json | Saída como JSON |
Exemplos:
bash
# Criação interativa de esquema
openspec schema init research-first
# Não interativo com artefatos específicos
openspec schema init rapid \
--description "Fluxo de trabalho de iteração rápida" \
--artifacts "proposal,tasks" \
--defaultO que ele cria:
openspec/schemas/<nome>/
├── schema.yaml # Definição do esquema
└── templates/
├── proposal.md # Modelo para cada artefato
├── specs.md
├── design.md
└── tasks.mdopenspec schema fork
Copia um esquema existente para o seu projeto para personalização.
openspec schema fork <source> [name] [options]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
source | Sim | Esquema a ser copiado |
name | Não | Nome do novo esquema (padrão: <source>-custom) |
Opções:
| Opção | Descrição |
|---|---|
--force | Sobrescreve o destino existente |
--json | Saída como JSON |
Exemplo:
bash
# Faz um fork do esquema spec-driven integrado
openspec schema fork spec-driven my-workflowopenspec schema validate
Valida a estrutura e os modelos de um esquema.
openspec schema validate [name] [options]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
name | Não | Esquema a ser validado (valida todos se omitido) |
Opções:
| Opção | Descrição |
|---|---|
--verbose | Mostra etapas detalhadas da validação |
--json | Saída como JSON |
Exemplo:
bash
# Valida um esquema específico
openspec schema validate my-workflow
# Valida todos os esquemas
openspec schema validateopenspec schema which
Mostra de onde um esquema é resolvido (útil para depurar precedência).
openspec schema which [name] [options]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
name | Não | Nome do esquema |
Opções:
| Opção | Descrição |
|---|---|
--all | Lista todos os esquemas com suas fontes |
--json | Saída como JSON |
Exemplo:
bash
# Verifica de onde um esquema vem
openspec schema which spec-drivenSaída:
spec-driven resolves from: package
Source: /usr/local/lib/node_modules/@fission-ai/openspec/schemas/spec-drivenPrecedência de esquemas:
- Projeto:
openspec/schemas/<nome>/ - Usuário:
~/.local/share/openspec/schemas/<nome>/ - Pacote: Esquemas integrados
Comandos de Configuração
openspec config
Visualize e modifique a configuração global do OpenSpec.
openspec config <subcomando> [opções]Subcomandos:
| Subcomando | Descrição |
|---|---|
path | Mostra a localização do arquivo de configuração |
list | Mostra todas as configurações atuais |
get <chave> | Obtém um valor específico |
set <chave> <valor> | Define um valor |
unset <chave> | Remove uma chave |
reset | Restaura para os padrões |
edit | Abre no $EDITOR |
profile [preset] | Configura o perfil de workflow interativamente ou via preset |
Exemplos:
bash
# Mostra o caminho do arquivo de configuração
openspec config path
# Lista todas as configurações
openspec config list
# Obtém um valor específico
openspec config get telemetry.enabled
# Define um valor
openspec config set telemetry.enabled false
# Define explicitamente um valor de string
openspec config set user.name "Meu Nome" --string
# Remove uma configuração personalizada
openspec config unset user.name
# Restaura toda a configuração
openspec config reset --all --yes
# Edita a configuração no seu editor
openspec config edit
# Configura o perfil com um assistente baseado em ações
openspec config profile
# Preset rápido: altera os workflows para core (mantém o modo de entrega)
openspec config profile coreopenspec config profile começa com um resumo do estado atual e então permite que você escolha:
- Alterar entrega + workflows
- Alterar apenas a entrega
- Alterar apenas os workflows
- Manter configurações atuais (sair)
Se você mantiver as configurações atuais, nenhuma alteração será gravada e nenhum prompt de atualização será exibido. Se não houver alterações na configuração, mas os arquivos do projeto atual estiverem desatualizados em relação ao seu perfil/entrega global, o OpenSpec mostrará um aviso e sugerirá executar openspec update. Pressionar Ctrl+C também cancela o fluxo de forma limpa (sem rastreamento de pilha) e sai com o código 130. Na lista de verificação de workflows, [x] significa que o workflow está selecionado na configuração global. Para aplicar essas seleções aos arquivos do projeto, execute openspec update (ou escolha Aplicar alterações a este projeto agora? quando solicitado dentro de um projeto).
Exemplos interativos:
bash
# Atualização apenas da entrega
openspec config profile
# escolha: Alterar apenas a entrega
# escolha a entrega: Somente Skills
# Atualização apenas dos workflows
openspec config profile
# escolha: Alterar apenas os workflows
# alterne os workflows na lista de verificação e confirmeComandos de Utilidade
openspec feedback
Envie feedback sobre o OpenSpec. Cria uma issue no GitHub.
openspec feedback <mensagem> [opções]Argumentos:
| Argumento | Obrigatório | Descrição |
|---|---|---|
mensagem | Sim | Mensagem de feedback |
Opções:
| Opção | Descrição |
|---|---|
--body <texto> | Descrição detalhada |
Requisitos: O GitHub CLI (gh) deve estar instalado e autenticado.
Exemplo:
bash
openspec feedback "Adicionar suporte para tipos de artefato personalizados" \
--body "Eu gostaria de definir meus próprios tipos de artefato além dos integrados."openspec completion
Gerencia completamentos de shell para o CLI do OpenSpec.
openspec completion <subcomando> [shell]Subcomandos:
| Subcomando | Descrição |
|---|---|
generate [shell] | Gera o script de completamento para stdout |
install [shell] | Instala o completamento para seu shell |
uninstall [shell] | Remove os completamentos instalados |
Shells suportados: bash, zsh, fish, powershell
Exemplos:
bash
# Instala completamentos (detecta o shell automaticamente)
openspec completion install
# Instala para um shell específico
openspec completion install zsh
# Gera o script para instalação manual
openspec completion generate bash > ~/.bash_completion.d/openspec
# Desinstala
openspec completion uninstallCódigos de Saída
| Código | Significado |
|---|---|
0 | Sucesso |
1 | Erro (falha de validação, arquivos ausentes, etc.) |
Variáveis de Ambiente
| Variável | Descrição |
|---|---|
OPENSPEC_TELEMETRY | Defina como 0 para desabilitar a telemetria |
DO_NOT_TRACK | Defina como 1 para desabilitar a telemetria (sinal DNT padrão) |
OPENSPEC_CONCURRENCY | Concorrência padrão para validação em massa (padrão: 6) |
EDITOR ou VISUAL | Editor para openspec config edit |
NO_COLOR | Desabilita a saída colorida quando definido |
Documentação Relacionada
- Comandos - Comandos slash de IA (
/opsx:propose,/opsx:apply, etc.) - Workflows - Padrões comuns e quando usar cada comando
- Personalização - Crie esquemas e templates personalizados
- Primeiros Passos - Guia de configuração inicial