Há duas formas de rodar o SpikeMe: o app web, que não precisa de instalação, e a CLI, que roda no seu terminal. Escolha a que combina com onde você trabalha.
Web
Sem instalação. Acesse spikeme.io/app e entre com um
magic link enviado para o seu e-mail. Uma vez lá dentro, envie um manifesto
(package.json, pyproject.toml, requirements.txt ou go.mod), escolha um
tema e leia
e compartilhe o documento gerado.
CLI
A CLI precisa do Node.js 18 ou mais novo. Rode uma vez, sem instalar nada:
npx spikeme
Ou instale de forma global para deixar o comando spikeme no seu PATH:
npm install -g spikeme
spikeme
Rodar spikeme sem argumentos analisa a stack do repositório atual. Essa etapa é
de graça e totalmente local: nada é enviado. Ela imprime sua stack, as
categorias e as lacunas que viram bons temas de spike.
Agente de código (MCP)
Se você trabalha com um agente como o Claude Code ou o Cursor, o SpikeMe também roda como servidor MCP — o agente analisa o repo e gera o documento de spike sem sair do editor. Sem instalação global:
claude mcp add spikeme -- npx -y spikeme-mcp
Entrar na conta
Gerar documentos (spikeme gen) passa pelo backend do SpikeMe, então exige uma
conta. Entre pelo terminal:
spikeme login
Isso inicia um login por device flow: o terminal mostra um código de uso único e
abre o seu navegador em https://spikeme.io/cli-login, onde você digita esse
código e aprova (você precisa estar logado no spikeme.io). Só informe um código
de um login que você mesmo iniciou. O token é salvo localmente e é renovado
sozinho. Veja a referência da CLI para o fluxo completo, tokens de
CI e requisitos de plano.
Próximos passos
- Gerando spikes: escolha um tema, defina profundidade e opções, e veja como o motor de evidência ancora o documento.
- Referência da CLI: todos os comandos, flags e variáveis de ambiente.
- Servidor MCP: use o SpikeMe de dentro do Claude Code ou do Cursor.