Skip to content
SlopCode

Introdução

slopcode é um agente de codificação de IA de código aberto. Está disponível como uma interface baseada em terminal, aplicativo desktop ou extensão de IDE.

slopcode TUI com o tema slopcode

Vamos começar.

Pré-requisitos

Para usar o slopcode no seu terminal, você precisará de:

  1. Um emulador de terminal moderno como:

  2. Chaves de API para os provedores de LLM que você deseja usar.

Instalação

A maneira mais fácil de instalar o slopcode é através do script de instalação.

Terminal window
curl -fsSL https://slopcode.dev/install | bash

Você também pode instalá-lo com os seguintes comandos:

  • Usando Node.js

    Terminal window
    npm install -g slopcode

  • Usando Homebrew no macOS e Linux

    Terminal window
    brew install slopcode

    Recomendamos usar o tap do slopcode para as versões mais atualizadas. A fórmula oficial brew install slopcode é mantida pela equipe do Homebrew e é atualizada com menos frequência.

  • Usando Paru no Arch Linux

    Terminal window
    sudo pacman -S slopcode           # Arch Linux (Stable)
    paru -S slopcode-bin              # Arch Linux (Latest from AUR)

Windows

  • Usando Chocolatey

    Terminal window
    choco install slopcode

  • Usando Scoop

    Terminal window
    scoop install slopcode

  • Usando NPM

    Terminal window
    npm install -g slopcode

  • Usando Mise

    Terminal window
    mise use -g github:grappeggia/slopcode

  • Usando Docker

    Terminal window
    docker run -it --rm ghcr.io/grappeggia/slopcode

O suporte para instalar o slopcode no Windows usando Bun está atualmente em andamento.

Você também pode baixar o binário na seção Releases.

Configuração

Com o slopcode, você pode usar qualquer provedor de LLM configurando suas chaves de API.

Se você é novo no uso de provedores de LLM, recomendamos usar o SlopCode Zen. É uma lista selecionada de modelos que foram testados e verificados pela equipe do slopcode.

  1. Execute o comando /connect no TUI, selecione slopcode e acesse slopcode.dev/auth.

    /connect

  2. Faça login, adicione seus dados de cobrança e copie sua chave de API.

  3. Cole sua chave de API.

    ┌ API key
    │
    │
    └ enter

Alternativamente, você pode selecionar um dos outros provedores. Saiba mais.

Inicialização

Agora que você configurou um provedor, pode navegar até um projeto no qual deseja trabalhar.

Terminal window
cd /path/to/project

E execute o slopcode.

Terminal window
slopcode

Em seguida, inicialize o slopcode para o projeto executando o seguinte comando.

/init

Isso fará com que o slopcode analise seu projeto e crie um arquivo AGENTS.md na raiz do projeto.

Isso ajuda o slopcode a entender a estrutura do projeto e os padrões de codificação utilizados.

Uso

Agora você está pronto para usar o slopcode para trabalhar em seu projeto. Sinta-se à vontade para perguntar qualquer coisa!

Se você é novo no uso de um agente de codificação de IA, aqui estão alguns exemplos que podem ajudar.

Fazendo perguntas

Você pode pedir ao slopcode para explicar a base de código para você.

How is authentication handled in @packages/functions/src/api/index.ts

Isso é útil se houver uma parte da base de código na qual você não trabalhou.

Adicionando recursos

Você pode pedir ao slopcode para adicionar novos recursos ao seu projeto. Embora primeiro recomendemos pedir para ele criar um plano.

  1. Criar um plano

    O slopcode tem um Modo de Plano que desabilita sua capacidade de fazer alterações e, em vez disso, sugere como implementará o recurso.

    Mude para ele usando a tecla Tab. Você verá um indicador para isso no canto inferior direito.

    <TAB>

    Agora vamos descrever o que queremos que ele faça.

    When a user deletes a note, we'd like to flag it as deleted in the database.
    Then create a screen that shows all the recently deleted notes.
    From this screen, the user can undelete a note or permanently delete it.

    Você quer dar ao slopcode detalhes suficientes para entender o que você deseja. Ajuda conversar com ele como se você estivesse falando com um desenvolvedor júnior da sua equipe.

  2. Iterar sobre o plano

    Uma vez que ele lhe der um plano, você pode dar feedback ou adicionar mais detalhes.

    We'd like to design this new screen using a design I've used before.
    [Image #1] Take a look at this image and use it as a reference.

    O slopcode pode escanear qualquer imagem que você fornecer e adicioná-la ao prompt. Você pode fazer isso arrastando e soltando uma imagem no terminal.

  3. Construir o recurso

    Uma vez que você se sinta confortável com o plano, volte para o Modo de Construção pressionando a tecla Tab novamente.

    <TAB>

    E peça para ele fazer as alterações.

    Sounds good! Go ahead and make the changes.

Fazendo alterações

Para alterações mais simples, você pode pedir ao slopcode para construí-las diretamente sem precisar revisar o plano primeiro.

We need to add authentication to the /settings route. Take a look at how this is
handled in the /notes route in @packages/functions/src/notes.ts and implement
the same logic in @packages/functions/src/settings.ts

Você quer ter certeza de fornecer uma boa quantidade de detalhes para que o slopcode faça as alterações corretas.

Desfazendo alterações

Vamos supor que você peça ao slopcode para fazer algumas alterações.

Can you refactor the function in @packages/functions/src/api/index.ts?

Mas você percebe que não era isso que você queria. Você pode desfazer as alterações usando o comando /undo.

/undo

O slopcode agora reverterá as alterações que você fez e mostrará sua mensagem original novamente.

Can you refactor the function in @packages/functions/src/api/index.ts?

A partir daqui, você pode ajustar o prompt e pedir ao slopcode para tentar novamente.

Ou você pode refazer as alterações usando o comando /redo.

/redo

Compartilhamento

As conversas que você tem com o slopcode podem ser compartilhadas com sua equipe.

/share

Isso criará um link para a conversa atual e o copiará para sua área de transferência.

Aqui está uma conversa de exemplo com o slopcode.

Personalização

E é isso! Agora você é um profissional em usar o slopcode.

Para torná-lo seu, recomendamos escolher um tema, personalizar os atalhos de teclado, configurar formatadores de código, criar comandos personalizados ou brincar com a configuração do slopcode.