Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/content/docs/reference/custom-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ The agent instructions are merged with the workflow prompt, customizing the AI e
- **Frontmatter**: Can include `name`, `description`, `tools`, and `mcp-servers`
- **One per workflow**: Only one agent file can be imported per workflow

## Built-in Prompts
## Built-in Agent Files

The `gh aw init` command sets up workflow creation prompts including `debug-agentic-workflow` that helps debug and refine workflows using CLI tools (`gh aw logs`, `gh aw audit`, `gh aw run`, `gh aw compile`). These prompts are stored in `.github/prompts/` and provide conversational workflow authoring and debugging capabilities.
The `gh aw init` command sets up workflow creation agents including `debug-agentic-workflow` that helps debug and refine workflows using CLI tools (`gh aw logs`, `gh aw audit`, `gh aw run`, `gh aw compile`). These agent files are stored in `.github/agents/` and provide conversational workflow authoring and debugging capabilities.
20 changes: 10 additions & 10 deletions docs/src/content/docs/setup/agentic-authoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,23 @@ gh aw init

This creates:
- `.github/aw/github-agentic-workflows.instructions.md` - Custom Copilot instructions for better workflow authoring
- `.github/prompts/create-agentic-workflow.prompt.md` - Prompt for the `/create-agentic-workflow` command in Copilot Chat
- `.github/agents/create-agentic-workflow.agent.md` - Agent for the `/create-agentic-workflow` command in Copilot Chat

:::tip[VS Code integration]
Once initialized, GitHub Copilot will automatically use these instructions when you edit workflow files in VS Code. See [VS Code Integration](/gh-aw/setup/vscode/) for more details.
:::

## What is the `create-agentic-workflow` prompt?
## What is the `create-agentic-workflow` agent?

`.github/prompts/create-agentic-workflow.prompt.md` is a prompt file that contains the structure and instructions GitHub Copilot will use to generate a workflow markdown file that the `gh aw` CLI understands. A [prompt file](/gh-aw/reference/glossary/#prompt-files) is a specialized instruction set that customizes AI behavior for specific tasks.
`.github/agents/create-agentic-workflow.agent.md` is an agent file that contains the structure and instructions GitHub Copilot will use to generate a workflow markdown file that the `gh aw` CLI understands. An [agent file](/gh-aw/reference/glossary/#agent-files) is a specialized instruction set that customizes AI behavior for specific tasks.

Use the prompt when you want to:
Use the agent when you want to:
- Draft a new agentic workflow using natural language
- Iterate on workflow steps with AI assistance inside your editor

The prompt contains specialized instructions and toolset to enable efficient workflow authoring.
The agent contains specialized instructions and toolset to enable efficient workflow authoring.

## How to use the `create-agentic-workflow` prompt
## How to use the `create-agentic-workflow` agent

In Visual Studio Code with GitHub Copilot Chat or in Copilot CLI, enter the `/create-agentic-workflow` command:

Expand All @@ -48,19 +48,19 @@ This will start the agentic workflow authoring process with interactive guidance

## Other Agents and Chats

The prompt file can be loaded into other AI chat interfaces that support custom instructions. The prompt is designed to be compatible with various AI tools, although some features might require configuration and you'll need to allow running the compiler.
The agent file can be loaded into other AI chat interfaces that support custom instructions. The agent is designed to be compatible with various AI tools, although some features might require configuration and you'll need to allow running the compiler.

## Dictating Agentic Workflows

When creating agentic workflows using speech-to-text (dictation), you may encounter terminology mismatches and formatting issues common to voice recognition systems. To help correct these issues, use the [dictation instructions prompt](https://raw.githubusercontent.com/githubnext/gh-aw/main/.github/instructions/dictation.instructions.md) or <CopyEntireFileButton filePath="https://raw.githubusercontent.com/githubnext/gh-aw/main/.github/instructions/dictation.instructions.md" label="Copy full instructions" />.
When creating agentic workflows using speech-to-text (dictation), you may encounter terminology mismatches and formatting issues common to voice recognition systems. To help correct these issues, use the [dictation instructions](https://raw.githubusercontent.com/githubnext/gh-aw/main/.github/instructions/dictation.instructions.md) or <CopyEntireFileButton filePath="https://raw.githubusercontent.com/githubnext/gh-aw/main/.github/instructions/dictation.instructions.md" label="Copy full instructions" />.

This prompt helps rephrase text captured through speech-to-text recognition by:
These instructions help rephrase text captured through speech-to-text recognition by:
- Correcting project-specific terminology (e.g., "ghaw" → "gh-aw", "work flow" → "workflow")
- Transforming casual dictated sentences into clear, imperative task descriptions
- Removing filler words and improving technical tone
- Adding necessary context that might be implicit in spoken requests

Load the dictation prompt into your AI assistant before or after dictating your workflow instructions to improve accuracy and clarity.
Load the dictation instructions into your AI assistant before or after dictating your workflow instructions to improve accuracy and clarity.

## Designing Tasks with ChatGPT

Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/setup/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@ Commands are organized by workflow lifecycle: creating, building, testing, monit
Initialize your repository for agentic workflows.

```bash wrap
gh aw init # Configure .gitattributes, Copilot instructions, prompts
gh aw init # Configure .gitattributes, Copilot instructions, agents
gh aw init --mcp # Also setup MCP server integration for Copilot Agent
```

Configures `.gitattributes` to mark `.lock.yml` files as generated, adds Copilot instructions for better AI assistance, and sets up prompt files for workflow creation. The `--mcp` flag additionally creates GitHub Actions workflow for MCP server setup, configures `.vscode/mcp.json` for VS Code integration, and enables gh-aw MCP tools in Copilot Agent.
Configures `.gitattributes` to mark `.lock.yml` files as generated, adds Copilot instructions for better AI assistance, and sets up agent files for workflow creation. The `--mcp` flag additionally creates GitHub Actions workflow for MCP server setup, configures `.vscode/mcp.json` for VS Code integration, and enables gh-aw MCP tools in Copilot Agent.

#### `add`

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/setup/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ You can leverage the help of an agent to customize your workflow without having
```bash wrap
# install copilot cli
npm install -g @github/copilot-cli
# install the prompt files
# install the agent files
gh aw init
```

Expand Down