metiatech/skill-cli-design

Lista de verificação para design de CLI

Ajuda e versão

• Uma CLI DEVE fornecer as flags --help e -h com uso claro, opções e exemplos. Os exemplos DEVEM incluir todos os parâmetros necessários.
• Uma CLI DEVE fornecer as flags --version e -V. O agente DEVE reservar -v para --verbose.

Entrada e saída

• Uma CLI DEVE suportar piping stdin/stdout e DEVE permitir redirecionamento de saída (por exemplo, --output para criação de arquivo).
• Uma CLI que emite dados estruturados DEVE oferecer saída legível por máquina (por exemplo, --json).

Segurança e controle

• Uma CLI que modifica ou exclui dados DEVE fornecer --dry-run e uma flag explícita de bypass (--yes ou --force).
• Uma CLI DEVE fornecer log controlável (--quiet, --verbose ou --trace).
• Uma CLI DEVE usar códigos de saída determinísticos: 0 para sucesso, não-zero para falha. O agente NÃO DEVE introduzir fallbacks silenciosos.
• Uma CLI DEVE implementar modos estritamente não interativos para ambientes CI/CD.

Configuração

• Uma CLI que consome configuração JSON DEVE definir e atualizar um JSON Schema e DEVE validar a configuração no carregamento.
• Uma CLI DEVE suportar configuração via variáveis de ambiente para dados sensíveis ou específicos do ambiente.

Prompts interativos

• Um prompt interativo DEVE fornecer o contexto necessário antes de perguntar. Para prompts sim/não, Enter DEVE significar "Sim" e "n" DEVE significar "Não".