Custom agents for GitHub Copilot CLI.
This option can either be:
- An attribute set defining agents
- A path to a directory containing multiple agent files
If an attribute set is used, the attribute name becomes the agent filename, and the value is either:
- Inline content as a string (creates ${configDir}/agents/<name>.agent.md)
- A path to a file (creates ${configDir}/agents/<name>.agent.md)
If a path is used, it is expected to contain agent files. The directory is symlinked to ${configDir}/agents/.
See https://docs.github.com/en/copilot/reference/copilot-cli-reference/cli-command-reference#custom-agents-reference for the documentation.
Declarations
Type
(attribute set of (strings concatenated with "\n" or absolute path or string)) or absolute pathDefault
{ }Example
{
code-reviewer = ''
---
description: High signal code review for logic, security, and test gaps.
tools: ["*"]
---
Review the current changes and report only actionable findings.
'';
documentation = ./agents/documentation.agent.md;
}