Introdução geral
O Sidekick CLI é uma ferramenta de linha de comando de código aberto projetada para simplificar o processo de desenvolvimento e implantação de projetos para desenvolvedores com assistência de IA. Ela é suportada por Claude Código, copiloto e Cursor A CLI do Sidekick é inspirada no Modelo de Linguagem do Sidekick e oferece funcionalidade semelhante, mas permite que os usuários escolham livremente um provedor de Modelo de Linguagem Grande (LLM) para evitar a dependência do fornecedor.A CLI do Sidekick foi projetada com um design "CLI-first" e suporta servidores de Protocolo de Contexto de Modelo (MCP) para ampliar as interações de IA.A CLI do Sidekick foi projetada com um design "CLI-first" e suporta servidores de Protocolo de Contexto de Modelo (MCP). O Sidekick CLI foi projetado com um design "CLI-first" e oferece suporte a servidores MCP (Model Context Protocol), ampliando os recursos de interação de IA. É ideal para desenvolvedores independentes ou equipes pequenas configurarem projetos rapidamente, implementarem em VPS e fornecerem geração de código e suporte à depuração por meio de IA. O projeto está atualmente na versão Beta, hospedado no GitHub, mantido pelo desenvolvedor Gavin Vickery (geekforbrains), sob a licença MIT, e recebe contribuições e feedback da comunidade.
Lista de funções
- Desenvolvimento assistido por IAGeração de código, depuração de problemas ou consulta de documentação com dicas de linguagem natural e suporte a vários provedores de LLM.
- Troca flexível de modelosAlternância perfeita entre diferentes modelos de IA na mesma sessão para se adaptar a diferentes requisitos de tarefas.
- Suporte ao servidor MCPConecte-se a ferramentas e fontes de dados externas para aprimorar os recursos de IA, como a recuperação de código do GitHub.
- Documento de orientação do projeto: através de
SIDEKICK.md
Personalize a pilha de tecnologia e as preferências de desenvolvimento do projeto. - Implementação de VPS em um cliqueConfigure automaticamente seu ambiente VPS, instale o Docker e o Traefik e ofereça suporte a domínios HTTPS.
- Desfazer: Uso
/undo
Desfaça rapidamente as alterações incorretas causadas pela IA. - Rastreamento de custos e tokensMonitorar os custos de uso do LLM e o consumo de tokens e definir limites orçamentários.
- controle de telemetria: através de
--no-telemetry
Desative o rastreamento de bugs e a análise de uso do Sentry. - Controle de confirmação de comando: Suporte
/yolo
Modo Skip Confirmation (Ignorar confirmação) ou pressione Session Adjustment (Ajuste de sessão) para confirmar a configuração.
Usando a Ajuda
Processo de instalação
A CLI do Sidekick é fácil de instalar e suporta o uso do pip
ou instalação do código-fonte. Veja a seguir as etapas detalhadas:
- Verificação dos requisitos do sistema
Certifique-se de que o Python 3.8+ e opip
Os usuários do Windows são aconselhados a instalar o Git Bash ou o WSL para obter uma melhor experiência no terminal. Os usuários do macOS e do Linux não precisam de nenhuma configuração adicional. - Instalação via pip
Execute o seguinte comando para instalar o Sidekick CLI:pip install sidekick-cli
Após a conclusão da instalação, verifique a versão:
sidekick --version
- Instalação a partir da fonte(para desenvolvedores)
Clonar um repositório do GitHub:git clone https://github.com/geekforbrains/sidekick-cli.git cd sidekick-cli
Instale a dependência:
pip install .
Se o modo de desenvolvimento for necessário (as alterações de código entram em vigor em tempo real), execute:
pip install -e .
- configuração inicial
Execute a CLI do Sidekick pela primeira vez:sidekick
O sistema solicita a configuração do provedor de LLM (por exemplo, OpenAI, Anthropic). As informações de configuração são armazenadas na seção
~/.config/sidekick.json
. Exemplo de configuração:{ "llm_providers": { "openai": { "api_key": "<你的API密钥>", "model": "gpt-4" } }, "mcpServers": { "fetch": { "command": "uvx", "args": ["mcp-server-fetch"] } } }
Você pode editar manualmente o arquivo para adicionar mais provedores de LLM ou MCP Servidor.
- Verificar a instalação
Execute o seguinte comando para confirmar que a CLI do Sidekick está funcionando corretamente:sidekick --version
Se o número da versão for retornado (por exemplo
0.1.0
), a instalação foi bem-sucedida.
Guia de operação de funções
1. desenvolvimento assistido por IA
A função principal da CLI do Sidekick é o desenvolvimento assistido por IA. Execute o seguinte comando para gerar código:
sidekick generate --prompt "编写一个 Flask REST API"
O AI gera o código quando solicitado e o salva em um arquivo especificado. Você também pode depurar o código:
sidekick debug --file app.py
Esse comando analisa o código, aponta erros e sugere correções. Se as modificações de IA causarem problemas, você poderá usar a função desfazer:
sidekick /undo
Desfazer restaura as alterações mais recentes e é bom para correções rápidas de bugs.
2. comutação flexível de modelos
A CLI do Sidekick permite alternar entre modelos de IA em uma sessão. Veja os modelos disponíveis:
sidekick /model
Exemplo de saída:
0: gpt-4 (OpenAI)
1: claude-3 (Anthropic)
Mudar para um modelo específico:
sidekick /model 0
Essa função é adequada para selecionar um modelo mais apropriado de acordo com os requisitos da tarefa.
3. suporte ao servidor MCP
O servidor MCP amplia os recursos da CLI do Sidekick. Por exemplo, configure o servidor MCP do GitHub para recuperar o código:
{
"mcpServers": {
"github": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-github"],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<你的GitHub令牌>"
}
}
}
}
Depois de salvar, execute o seguinte comando para testar a função MCP:
sidekick fetch --repo <GitHub仓库地址>
O servidor MCP oferece à IA acesso direto a fontes de dados externas, aprimorando a geração e a análise de códigos.
4. documento de orientação do projeto
A CLI do Sidekick oferece suporte à criação do arquivo SIDEKICK.md
que define a pilha de tecnologia e as preferências de desenvolvimento do projeto. Exemplo SIDEKICK.md
::
# Sidekick Guide
- Tech Stack: Python, Flask, PostgreSQL
- Coding Style: PEP 8
- Project Structure: MVC
- Preferred LLM: gpt-4
Depois de criado, o Sidekick CLI ajusta o comportamento da IA com base nesse arquivo. Execute o seguinte comando para aplicar o guia:
sidekick init
5. implantação de VPS com um clique
O Sidekick CLI simplifica a implementação de VPS para sistemas Ubuntu 20.04+. Execute o seguinte comando:
sidekick deploy --vps <VPS_IP地址>
A CLI do Sidekick será ativada automaticamente:
- Configure o SSH e as permissões de usuário.
- Instale o Docker e o Traefik.
- Definir HTTPS (usado por padrão)
sslip.io
(nome de domínio gratuito).
Verifique o status da implantação:
sidekick status
Atualize o aplicativo:
sidekick deploy --update
Esse recurso permite a implementação sem tempo de inatividade e é adequado para projetos de ativação rápida.
6. rastreamento de custos e tokens
A CLI do Sidekick fornece monitoramento do uso do LLM. Veja o consumo atual:
sidekick cost
A saída inclui contagens de tokens e estimativas de custo. Defina o orçamento:
sidekick cost --set-budget 20.0
A CLI do Sidekick avisa quando os custos estão próximos do orçamento.
7. controle de telemetria
A CLI do Sidekick ativa a telemetria Sentry por padrão para coletar dados de erro e de uso. Desativar a telemetria:
sidekick --no-telemetry
Esse comando garante que os usuários sensíveis à privacidade possam desativar completamente a coleta de dados.
8. controle de confirmação de comando
Para acelerar a operação, ative o modo "yolo" para pular a confirmação:
sidekick /yolo
Confirmação da restauração:
sidekick /yolo off
Você também pode definir o comportamento padrão por meio de um arquivo de configuração:
{
"skip_confirm": true
}
Comandos comuns
/help
Exibe todos os comandos./clear
Limpa o histórico de mensagens./compact
Resumo do histórico de mensagens: resume o histórico de mensagens e limpa registros antigos./dump
Histórico de mensagens: Exibe o histórico de mensagens atual (para depuração).exit
Sair da CLI do Sidekick.
advertência
- Segurança da chave de APIPara garantir que
~/.config/sidekick.json
A chave não é comprometida na - Requisitos de VPSImplementação: A implementação requer portas SSH abertas (padrão 22) e IPs públicos.
- Limite da fase betaObservação: Pode haver erros na versão atual, portanto, fique de olho no repositório do GitHub para obter atualizações.
cenário do aplicativo
- Prototipagem rápida
Os desenvolvedores precisam criar protótipos de aplicativos da Web rapidamente. A CLI do Sidekick gera código e automatiza a configuração por meio de IA, levando o processo da ideia à implementação em questão de dias. - Implantação de VPS de baixo custo
Para equipes pequenas que desejam executar aplicativos em VPS de baixo orçamento, a CLI do Sidekick oferece implantação com um clique e rastreamento de custos para garantir o uso eficiente dos recursos. - Aprendizagem orientada por IA
Os iniciantes aprendem novas estruturas com os recursos de IA da CLI do Sidekick. Insira prompts de linguagem natural para gerar código de amostra e depurar para entender a lógica.
QA
- A CLI do Sidekick precisa estar sempre conectada?
Sim, a funcionalidade de IA depende da API do provedor do LLM e requer uma conexão de rede. As implementações de servidor MCP e VPS também requerem uma conexão de rede. - Como faço para desativar a telemetria?
estar em movimentosidekick --no-telemetry
ou emsidekick.json
configurar"telemetry": false
. - Quais provedores de LLM são aceitos?
Atualmente é compatível com OpenAI, Anthropic, etc., e será adicionado no futuro. Ollama e outros modelos locais (consulte o Roteiro). - Como faço para contribuir com o código?
Clone o repositório e instale as dependências de desenvolvimento (make install
), envie o Pull Request para o GitHub.