Adding custom instructions for GitHub Copilot CLI

O GitHub Copilot pode fornecer respostas que são adequadas às suas preferências pessoais, à forma como sua equipe trabalha, às ferramentas que você usa ou às particularidades do seu projeto, se você fornecer contexto suficiente para isso. Em vez de adicionar repetidamente esse detalhe contextual aos seus prompts, você pode criar instruções personalizadas que adicionam automaticamente essas informações para você. As informações adicionais não são exibidas, mas estão disponíveis para o Copilot, a fim de permitir que ele gere respostas de melhor qualidade.

Tipos de instruções personalizadas

CLI do GitHub Copilot dá suporte aos seguintes tipos de instruções personalizadas.

Instruções personalizadas em todo o repositório

Elas se aplicam a todas as solicitações feitas no contexto de um repositório.

Eles são especificados em um arquivo copilot-instructions.md no diretório .github na raiz do repositório. Consulte Como criar instruções personalizadas em todo o repositório.

Instruções personalizadas específicas de caminho

Elas se aplicam a solicitações feitas no contexto de arquivos que correspondem a um caminho especificado.

Eles são especificados em um ou mais arquivos NAME.instructions.md dentro ou abaixo do diretório .github/instructions na raiz do repositório ou dentro ou abaixo de um diretório .github/instructions no diretório de trabalho atual. Consulte Como criar instruções personalizadas específicas do caminho.

Se o caminho que você especificar nessas instruções corresponder a um arquivo no qual Copilot estiver funcionando e um arquivo de instruções personalizadas em todo o repositório também existir, as instruções de ambos os arquivos serão usadas. Você deve evitar possíveis conflitos entre instruções, pois a escolha de Copilot entre instruções conflitantes é não determinística.

Instruções do agente

Eles são usados por vários agentes de IA.

Você pode criar um ou mais AGENTS.md arquivos. Elas podem estar localizadas no diretório raiz do repositório, no diretório de trabalho atual ou em qualquer um dos diretórios especificados por uma lista separada por vírgulas de caminhos na variável de COPILOT_CUSTOM_INSTRUCTIONS_DIRS ambiente.

As instruções no AGENTS.md arquivo no diretório raiz, se encontradas, são tratadas como instruções primárias. Se um arquivo AGENTS.md e um arquivo .github/copilot-instructions.md forem encontrados na raiz do repositório, as instruções em ambos os arquivos serão usadas.

As instruções encontradas em outros AGENTS.md arquivos são tratadas como instruções adicionais. As instruções primárias encontradas provavelmente terão mais impacto sobre as respostas de Copilot do que as instruções adicionais.

Para obter mais informações, consulte o repositório agentsmd/agents.md.

Como alternativa, você pode usar CLAUDE.md e GEMINI.md arquivos. Eles devem estar localizados na raiz do repositório.

Instruções locais

Elas se aplicam em um ambiente local específico.

Você pode especificar instruções em seu próprio diretório base, criando um arquivo em $HOME/.copilot/copilot-instructions.md.

Você também pode definir a COPILOT_CUSTOM_INSTRUCTIONS_DIRS variável de ambiente para uma lista separada por vírgulas de diretórios. CLI do Copilot procurará um arquivo AGENTS.md e quaisquer arquivos .github/instructions/**/*.instructions.md em cada um desses diretórios.

Como criar instruções personalizadas em todo o repositório

Na raiz do repositório, crie um arquivo chamado .github/copilot-instructions.md.

Crie o diretório .github se ele ainda não existir.
Adicione instruções em linguagem natural ao arquivo, no formato Markdown.

O espaço em branco entre as instruções é ignorado, de modo que as instruções podem ser escritas como um só parágrafo, cada uma em uma nova linha ou separadas por linhas em branco para facilitar a leitura.

Para obter ajuda sobre como escrever instruções personalizadas eficazes, consulte Sobre a personalização das respostas do GitHub Copilot.

Criar instruções personalizadas específicas para o caminho

Crie o diretório .github/instructions se ele ainda não existir.
Opcionalmente, crie subdiretórios de .github/instructions para organizar seus arquivos de instrução.
Crie um ou mais arquivos NAME.instructions.md, em que NAME indica a finalidade das instruções. O nome do arquivo deve terminar com .instructions.md.

No início do arquivo, crie um bloco frontmatter contendo a palavra-chave applyTo. Use a sintaxe glob para especificar a quais arquivos ou diretórios as instruções se aplicam.

Por exemplo:

---
applyTo: "app/models/**/*.rb"
---

Você pode especificar vários padrões separando-os com vírgulas. Por exemplo, para aplicar as instruções a todos os arquivos TypeScript no repositório, você pode usar o seguinte bloco frontmatter:

---
applyTo: "**/*.ts,**/*.tsx"
---

Exemplos do Glob:

     `*` – corresponderá a todos os arquivos no diretório atual.

     `**` ou `**/*` – todos corresponderão a todos os arquivos em todos os diretórios.

     `*.py` – corresponderá a todos os `.py` arquivos no diretório atual.

     `**/*.py` – corresponderá recursivamente a todos os `.py` arquivos em todos os diretórios.

     `src/*.py` – corresponderá a todos os `.py` arquivos no `src` diretório. Por exemplo, `src/foo.py` mas `src/bar.py`_não_`src/foo/bar.py`.

     `src/**/*.py` – corresponderá recursivamente a todos os `.py` arquivos no `src` diretório. Por exemplo, `src/foo.py`, `src/foo/bar.py` e `src/foo/bar/baz.py`.

     `**/subdir/**/*.py` – fará a correspondência recursiva de todos os arquivos `.py` em qualquer diretório `subdir` em qualquer profundidade. Por exemplo, `subdir/foo.py`, `subdir/nested/bar.py`, `parent/subdir/baz.py`e `deep/parent/subdir/nested/qux.py`, mas _não_`foo.py` em um caminho que não contém um `subdir` diretório.

Opcionalmente, para impedir que o arquivo seja usado por agente de codificação Copilot ou Revisão de código com Copilot, adicione a palavra-chave excludeAgent ao bloco de frontmatter. Use "code-review" ou "coding-agent".

Por exemplo, o arquivo a seguir será lido apenas por agente de codificação Copilot.
```
---
applyTo: "**"
excludeAgent: "code-review"
---
```
Se a excludeAgent palavra-chave não estiver incluída no bloco de matéria frontal, ambos Revisão de código com Copilot e agente de codificação Copilot usarão suas instruções.
Adicione suas instruções personalizadas em linguagem natural usando o formato Markdown. O espaço em branco entre as instruções é ignorado, de modo que as instruções podem ser escritas como um só parágrafo, cada uma em uma nova linha ou separadas por linhas em branco para facilitar a leitura.

Adicionou com êxito um arquivo de instruções personalizado ao repositório?

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Sim</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>Não</span></a>

Instruções personalizadas em uso

As instruções nos arquivos estarão disponíveis para uso por Copilot assim que você salvar os arquivos. As instruções são adicionadas automaticamente às solicitações que você envia para Copilot.

Se você fizer alterações nas suas instruções personalizadas durante uma sessão da CLI, essas alterações estarão disponíveis para uso pelo Copilot na próxima vez em que você enviar um prompt nas sessões atuais ou futuras.

Leitura adicional

        [AUTOTITLE](/copilot/reference/custom-instructions-support)

        [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions) — uma coleção de exemplos curada

        [AUTOTITLE](/copilot/tutorials/use-custom-instructions)

Adding custom instructions for GitHub Copilot CLI

Neste artigo