You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/content/docs/reference/custom-agent-for-aw.mdx
+5-47Lines changed: 5 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,20 +27,13 @@ Follow these steps to set up your repository for agentic workflows using the cus
27
27
Initialize this repository for GitHub Agentic Workflows using https://github.com/github/gh-aw/blob/main/install.md
28
28
```
29
29
30
-
This will guide your coding agent to:
31
-
- Install the `gh-aw` CLI extension
32
-
- Run `gh aw init` to create necessary configuration files
33
-
- Commit and push the changes, or create a pull request
34
-
35
30
Alternatively just run
36
31
37
32
```bash
38
33
gh aw init
39
34
```
40
35
41
-
After initialization, you'll have:
42
-
-`.github/agents/agentic-workflows.agent.md` - [A Copilot file](/gh-aw/reference/glossary/#agent-files) (custom AI instructions) for the `/agent agentic-workflows` command in Copilot Chat
43
-
- Additional configuration files for workflow authoring
36
+
After initialization, you'll have `.github/agents/agentic-workflows.agent.md`, a [Copilot agent file](/gh-aw/reference/glossary/#agent-files) that registers the `/agent agentic-workflows` command in Copilot Chat.
44
37
45
38
## Using the Copilot Agent Files for Agentic Workflows
46
39
@@ -82,14 +75,10 @@ Import workflows from any accessible GitHub repository:
82
75
/agent agentic-workflows import workflow from https://github.com/githubnext/agentics/blob/main/workflows/ci-doctor.md
83
76
```
84
77
85
-
When importing, you can specify customizations:
78
+
When importing, you can specify customizations such as engine or tools:
86
79
87
80
```text wrap
88
-
# Import and change engine
89
81
/agent agentic-workflows import issue-triage from githubnext/agentics and use claude engine
90
-
91
-
# Import and add tools
92
-
/agent agentic-workflows import pr-review from owner/repo and add web-fetch tool
93
82
```
94
83
95
84
### Debugging Agentic Workflows
@@ -100,40 +89,13 @@ When workflows fail or behave unexpectedly, use the agentic-workflows agent to i
100
89
/agent agentic-workflows debug why is my issue-triage workflow failing?
101
90
```
102
91
103
-
You can investigate a specific workflow run using its ID or URL:
92
+
For the fastest diagnosis, pass the full run URL from the GitHub Actions page:
> Replace `OWNER`, `REPO`, and `RUN_ID` with your values. The agent will audit logs, identify the root cause, and suggest targeted fixes.
121
-
122
-
The agent can help with various debugging scenarios:
123
-
124
-
```text wrap
125
-
# Permission errors
126
-
/agent agentic-workflows debug getting 403 errors in my workflow
127
-
128
-
# Missing tools
129
-
/agent agentic-workflows debug workflow says tool not found
130
-
131
-
# Network access issues
132
-
/agent agentic-workflows debug workflow cannot access external API
133
-
134
-
# Safe-output problems
135
-
/agent agentic-workflows debug agent output not creating issues
136
-
```
98
+
The agent audits logs, identifies the root cause, and suggests targeted fixes. It handles permission errors, missing tools, network access issues, and safe-output problems — just describe the issue in natural language.
137
99
138
100
### Self-Contained Debugging (Without Copilot)
139
101
@@ -149,10 +111,6 @@ The failed workflow run is at https://github.com/OWNER/REPO/actions/runs/RUN_ID
149
111
150
112
The `debug.md` file is a self-contained prompt that works with any coding agent or AI assistant. It guides the agent to install `gh aw`, analyze the run logs, identify the root cause, and open a pull request with the fix.
151
113
152
-
## Other Agents and Chats
153
-
154
-
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.
155
-
156
114
## Creating Agentic Workflows with an AI Chatbot
157
115
158
116
If you prefer to use an AI chatbot to author agentic workflows, use the [agentic-chat instructions](https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/agentic-chat.md) with any conversational AI application. <CopyEntireFileButtonfilePath="https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/agentic-chat.md"label="Copy agentic-chat instructions" />
0 commit comments