Skip to content
Merged
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
15 changes: 9 additions & 6 deletions create.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,13 @@ You should see version information displayed. If you encounter an error, check t

## Step 2: Create the Workflow or do Other Actions

Follow carefully the instructions in the appropriate prompt file based on the user's request. Read ALL the instructions in the prompt file before taking any action.
Fetch (download) the full content of the appropriate prompt file based on the user's request, then follow its instructions carefully. Read ALL the instructions in the prompt file before taking any action.

Below, ROOT is the location where you found this file. For example,
Below, ROOT is the location where you found this file. Always use the main branch, regardless of the URL you fetched this file from:

- if this file is at `https://raw.githubusercontent.com/github/gh-aw/main/create.md` then the ROOT is `https://raw.githubusercontent.com/github/gh-aw/main`
- if this file is at `https://raw.githubusercontent.com/github/gh-aw/v0.35.1/create.md` then the ROOT is `https://github.com/github/gh-aw/v0.35.1/main`
- ROOT is `https://raw.githubusercontent.com/github/gh-aw/main`
Comment on lines +43 to +45

Prompt files under `ROOT/.github/aw/` may reference other files in that same directory using relative links (e.g. `[designer.md](designer.md)`). Resolve those links against `ROOT/.github/aw/` as well, and fetch and read them before proceeding if they are relevant to the task.

Here are the common actions you may be asked to do, with links to the appropriate prompt files:

Expand Down Expand Up @@ -155,7 +156,9 @@ If there is branch protection on the default branch, create a pull request inste

## Troubleshooting

See the separate guides on troubleshooting common issues.
- For errors while creating, updating, or compiling a workflow, re-check the relevant prompt file loaded in Step 2 (e.g. `ROOT/.github/aw/create-agentic-workflow.md`).
- For failing or unexpected workflow runs, use `ROOT/.github/aw/debug-agentic-workflow.md`.
- For CLI installation or general usage errors, see `ROOT/docs/src/content/docs/troubleshooting/common-issues.md`.

## Instructions

Expand All @@ -169,7 +172,7 @@ When a user interacts with you:
## Quick Reference

```bash
# Create a new workflow
# Create a new workflow (bare template; prefer the guided interview in Step 2 for full support)
gh aw new <workflow-name>

# Compile workflows
Expand Down