O Cipher é uma ferramenta de camada de memória de código aberto projetada para assistentes de codificação. Ele faz isso por meio da ferramenta Modelo de protocolo de contexto (MCP) O protocolo se integra perfeitamente a uma ampla gama de ferramentas de programação e assistentes de IA, como Claude A função principal do Cipher é armazenar e gerenciar informações contextuais durante o processo de codificação, ajudando os desenvolvedores a manter a continuidade em projetos complexos. Ele é compatível com várias configurações de ambiente e é adequado para desenvolvedores individuais ou equipes. O projeto é de código aberto no GitHub, permitindo que a comunidade contribua com melhorias no código e nos recursos. Os usuários podem implantá-lo e usá-lo rapidamente por meio de operações simples de linha de comando ou do modo API.
Lista de funções
- Fornece uma camada de memória persistente para armazenar informações contextuais sobre interações de programação.
- Oferece suporte ao protocolo MCP e é compatível com ferramentas como Claude Code, Cursor, Windsurf e outras.
- Fornece uma interface de linha de comando (CLI) que suporta o modo interativo e operações de comando único.
- Oferece suporte aos modos de servidor API e MCP para atender a diferentes necessidades de desenvolvimento.
- Configuração flexível usando variáveis de ambiente e arquivos YAML.
- Oferece suporte a chaves de API para uma ampla variedade de modelos de IA, como OpenAI, Anthropic e OpenRouter.
- Fornece opções de implantação do Docker para simplificar o processo de instalação e tempo de execução.
- Permitir contribuições da comunidade e apoiar o desenvolvimento colaborativo de código aberto.
Usando a Ajuda
Processo de instalação
O Cipher tem um processo de instalação simples, suporta instalação global ou local e oferece opções de implantação do Docker. Veja abaixo as etapas detalhadas:
Instalar via npm
- instalação globalExecute o seguinte comando em um terminal para instalar as ferramentas de linha de comando do Cipher:
npm install -g @byterover/cipher
Isso instala o Cipher globalmente para os desenvolvedores que precisam usá-lo com frequência.
- instalação localSe ele for usado somente em um projeto específico, vá para o diretório do projeto e execute-o:
npm install @byterover/cipher
Clonagem e configuração via Git
- armazém de clonesClone o projeto Cipher localmente a partir do GitHub:
git clone https://github.com/campfirein/cipher.git cd cipher
- Cópia de arquivos de configuraçãoCopie o arquivo de configuração de ambiente de amostra e edite-o:
cp .env.example .env
Abrir com um editor de texto
.env
adicione as chaves de API necessárias, por exemplo:OPENAI_API_KEY=your_openai_api_key ANTHROPIC_API_KEY=your_anthropic_api_key OPENROUTER_API_KEY=your_openrouter_api_key
Se você usar o Ollama que pode ser configurado:
OLLAMA_BASE_URL=http://localhost:11434/v1
- Instalação de dependênciasExecute no diretório do projeto:
npm install
Implementação via Docker
- Certifique-se de que o Docker e o Docker Compose estejam instalados.
- Execute-o no diretório do projeto:
docker-compose up -d
Isso iniciará o serviço Cipher.
- Testa se o serviço está funcionando corretamente:
curl http://localhost:3000/health
Se o status de retorno for normal, o serviço será iniciado.
Uso
O Cipher oferece vários modos de operação, incluindo o modo interativo, comando único, modo de servidor API e modo de servidor MCP. Veja a seguir os métodos de operação específicos:
modo interativo
- Digite-o no terminal:
cipher
Isso leva a uma interface de linha de comando interativa em que o desenvolvedor pode inserir comandos ou perguntas e o Cipher armazena o contexto e fornece uma resposta.
- Exemplo: digite "Documentar causas comuns de erros de CORS no desenvolvimento local do Vite + Express" e o Cipher armazenará as informações na memória para consultas subsequentes.
comando único
- Executar um único comando para armazenar informações específicas:
cipher "Add this to memory as common causes of 'CORS error' in local dev with Vite + Express."
Isso armazenará o conteúdo especificado diretamente na camada de memória.
Modo de servidor API
- Inicie o servidor de API:
cipher --mode api
- Use solicitações HTTP para interagir com o Cipher, por exemplo, por meio do
curl
ou outras ferramentas para chamar os pontos de extremidade da API.
Modelo de servidor MCP
- Inicie o servidor MCP para oferecer suporte a ferramentas compatíveis:
cipher --mode mcp
- configurar Código Claude talvez Cursor etc., para se conectar ao endereço do servidor MCP do Cipher (padrão)
http://localhost:3000
).
Funções principais
Armazenamento e recuperação de contexto
No centro do Cipher está seu sistema de memória dupla, capaz de armazenar conceitos de programação e padrões de raciocínio. Por exemplo, ao usar o Claude Code, o conteúdo de cada interação do desenvolvedor é automaticamente armazenado na camada de memória do Cipher. Quando necessário, execute o seguinte comando para recuperá-lo:
cipher "Retrieve context about CORS error causes"
O Cipher retorna o contexto relevante para ajudar os desenvolvedores a voltarem ao trabalho rapidamente.
Configuração de variáveis de ambiente
O desenvolvedor pode modificar o .env
Nível de registro de ajuste de arquivo ou outras configurações, por exemplo:
CIPHER_LOG_LEVEL=info
NODE_ENV=production
Isso garante que o Cipher seja estável em ambientes de produção.
Integração de ferramentas de terceiros
A Cipher se integra a ferramentas como Claude Code, Cursor, etc. por meio do protocolo MCP. Uma vez configuradas, as ferramentas enviam automaticamente os dados de interação para a Cipher para armazenamento. Por exemplo, se você ativar o cliente MCP no Claude Code e definir o endereço do servidor como o endereço MCP do Cipher, os dados poderão ser sincronizados em tempo real.
advertência
- Certifique-se de configurar pelo menos uma chave de API (
OPENAI_API_KEY
(deve ser fornecido para incorporação). - A implantação do Docker requer um ambiente de rede estável para garantir downloads de imagens sem problemas.
- Os colaboradores da comunidade podem consultar o GitHub
Contributing Guide
Enviar código.
cenário do aplicativo
- Gerenciamento de projetos de desenvolvedores individuais
Ao trabalhar em projetos complexos, os desenvolvedores geralmente precisam registrar trechos de código ou informações de depuração. O Cipher oferece uma camada de memória persistente que armazena o contexto do processo de depuração para facilitar a recuperação a qualquer momento. - Desenvolvimento do trabalho em equipe
As equipes de desenvolvimento podem compartilhar o contexto do projeto usando o modelo de servidor MCP do Cipher. Os membros da equipe acessam a camada de memória unificada por meio do Claude Code ou do Cursor para uma colaboração mais eficiente. - Aprendizagem e ensino
Iniciantes em programação ou instrutores podem usar o Cipher para registrar problemas e soluções durante o aprendizado de código. Por exemplo, registre as causas e soluções dos erros de CORS para facilitar a revisão. - Aprimoramento do AI Assistant
O Cipher oferece suporte de memória para assistentes de codificação de IA, aprimorando sua capacidade de lidar com contextos longos. Por exemplo, os usuários do Claude Code podem usar o Cipher para armazenar o contexto de várias rodadas de diálogo, garantindo que o assistente de IA forneça conselhos mais precisos.
QA
- Quais ferramentas de programação são compatíveis com o Cipher?
A Cipher oferece suporte ao protocolo MCP com Claude Code, Cursor, Windsurf, Gemini CLI, AWS Kiro, VS Code e Código Roo e outras integrações de ferramentas. - Preciso de uma chave de API?
Sim, pelo menos uma chave de API da OpenAI é necessária para incorporar a funcionalidade. Outras chaves de API (como Antrópica ou OpenRouter) é opcional. - Como faço para depurar o serviço Cipher?
estar em movimentocurl http://localhost:3000/health
Verifique o status do serviço ou, na seção.env
Configuração no arquivoCIPHER_LOG_LEVEL=debug
Veja os registros detalhados. - Qual é a diferença entre a implantação do Docker e a instalação direta?
As implantações do Docker são boas para ambientes isolados e de início rápido, e as instalações diretas são boas para desenvolvedores que precisam de personalização profunda.