Referência da CLI

Instale a CLI do SpikeMe e use-a para analisar sua stack e gerar documentos de spike pelo terminal.

A CLI do SpikeMe analisa seu repositório localmente e gera documentos de spike pelo terminal, onde seu código já mora. A análise é de graça e nunca sai da sua máquina. A geração passa pelo backend do SpikeMe e é medida pelo seu plano.

Instalação

A CLI precisa do Node.js 18 ou mais novo. Rode uma vez, sem instalar:

npx spikeme

Ou instale de forma global para deixar o spikeme no seu PATH:

npm install -g spikeme
spikeme

Comandos

Comando	O que faz
`spikeme`	Analisa a stack do repositório atual. De graça, local, nada enviado.
`spikeme gen "<tema>"`	Gera um documento de spike completo para uma decisão.
`spikeme implement "<biblioteca>"`	Gera um guia de implementação para uma biblioteca já escolhida.
`spikeme login`	Entra na conta por um login de device flow no navegador.
`spikeme --help`	Mostra a ajuda. Atalhos: `-h`, `help`.
`spikeme --version`	Mostra a versão instalada. Atalho: `-v`.

`spikeme`

Rode sem argumentos para analisar o repositório atual. Ele parseia seu manifesto, imprime sua stack e as categorias dela, e lista as lacunas que viram bons temas de spike. É de graça, roda localmente e não envia nada.

Os manifestos suportados são package.json (npm), pyproject.toml e requirements.txt (Python) e go.mod (Go). Em um repositório poliglota, a CLI detecta mais de um.

spikeme

`spikeme gen "<tema>"`

Gera um documento de spike completo para uma decisão: opções analisadas, tabela de comparação, recomendação, plano de prova de conceito e riscos. Isso passa pelo backend do SpikeMe, então exige spikeme login e um plano ativo.

spikeme gen "gerenciamento de estado no nosso app React"

Veja opções do gen para as flags que controlam profundidade, número de opções, idioma e saída.

`spikeme implement "<biblioteca>"`

Depois que o spike decidiu qual biblioteca adotar, o implement gera um guia de implementação acionável para ela: o comando de instalação com versão travada (a partir dos fatos vivos), um exemplo mínimo funcional na stack do projeto, passos de integração com prazos, um checklist de prova de conceito e um plano de rollback. O SpikeMe gera o plano; ele não executa nada — você, ou o seu agente de código sob a sua confirmação, roda os comandos. Como o gen, passa pelo backend, então exige spikeme login e um plano ativo.

spikeme implement "zustand"

Use --topic <texto> para dar o contexto da decisão de onde a biblioteca veio. O implement também aceita as mesmas flags --lang, -o e --path do gen:

spikeme implement "zustand" --topic "gerenciamento de estado no nosso app React" --lang pt -o impl-zustand.md

`spikeme login`

Entra na conta pelo terminal por um login de device flow no navegador. Veja Login abaixo para o fluxo completo e a opção --token, amigável para CI.

spikeme login

Opções do gen

Flag	Valores	Padrão	Descrição
`--depth`	`quick` \| `full`	`full`	`quick` gera um doc menor e mais barato.
`--options`	`2` \| `3` \| `4`	`3`	Quantas opções analisar.
`--lang`	`en` \| `pt`	`en`	Idioma do documento gerado.
`-o, --out <arquivo>`	caminho	stdout	Escreve o documento em um arquivo, em vez de stdout.
`--path <dir>`	diretório	dir atual	De qual diretório ler o manifesto.

spikeme gen "qual ORM para o nosso serviço Node" --depth quick --options 4 --lang pt -o spike-orm.md

spikeme login inicia um device flow. O terminal mostra um código de uso único e abre o seu navegador em https://spikeme.io/cli-login. Você digita esse código lá e aprova. Você precisa estar logado no spikeme.io para isso funcionar, e só deve informar um código de um login que você mesmo iniciou.

spikeme login

Ao dar certo, o token é salvo em ~/.spikeme/credentials.json (modo 0600) e é renovado automaticamente, então você continua logado.

Em CI ou ambientes headless, onde não há navegador, passe um token diretamente ou defina no ambiente:

spikeme login --token "<token>"

O spikeme gen e o spikeme implement exigem um plano ativo (Starter ou Pro). Contas gratuitas geram na web. Veja Planos e cobrança para o que cada plano inclui.

Variáveis de ambiente

Variável	Descrição
`SPIKEME_TOKEN`	Token de autenticação usado no lugar do `spikeme login`. Útil em CI e ambientes headless.

export SPIKEME_TOKEN="<token>"
spikeme gen "jobs em background para nossa API Python"

Exemplos

Analise o repositório atual e veja os temas de spike sugeridos:

npx spikeme

Gere um spike rápido, com quatro opções, e escreva em um arquivo:

spikeme gen "setup de testes para o nosso monorepo" --depth quick --options 4 -o spike-testes.md

Gere um spike em inglês a partir de outro diretório:

spikeme gen "message queue" --lang en --path ../api

Gere em CI com um token vindo do ambiente:

export SPIKEME_TOKEN="<token>"
spikeme gen "qual cliente HTTP" -o spike-http.md