Skip to content
Merged
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 .github/workflows/squad-game-planner.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 10 additions & 30 deletions SKILL.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,19 @@
# gh-aw Prompt Surface
# gh-aw Loader

This repository builds **gh-aw** (GitHub Agentic Workflows), a GitHub CLI extension for writing workflows in markdown and compiling them to GitHub Actions.
GitHub Agentic Workflows (`gh-aw`) is a GitHub CLI extension for writing workflows in markdown and compiling them to GitHub Actions.

## What this surface does

- Converts markdown workflow specs (`.md`) into compiled lock files (`.lock.yml`)
- Supports multiple AI engines (`copilot`, `claude`, `codex`, `custom`)
- Integrates tools, including GitHub MCP servers and safe-output tooling
- Provides CLI commands to compile, run, inspect, and audit workflows

## Key concepts

1. **Workflow compilation**: edit workflow markdown, then recompile lock files
2. **Engine selection**: set `engine` in frontmatter to control runtime agent behavior
3. **MCP tools**: configure GitHub/MCP toolsets in frontmatter for repository operations
4. **Safe outputs**: workflow-safe issue/comment output paths and constraints

## Representative usage examples
## Install

```bash
# Compile markdown workflows to lock files
gh aw compile

# Run a workflow manually
gh aw run .github/workflows/daily-skill-optimizer.md
gh extension install github/gh-aw
```

# Inspect MCP server usage in workflows
gh aw mcp list
gh aw mcp inspect daily-skill-optimizer
Script install:

# Audit a workflow run
gh aw audit 24814681146
```bash
curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | bash
```

## Where to learn more in this repo
## Load

- `/AGENTS.md` for development/agent workflow conventions
- `/skills/*/SKILL.md` for focused domain guidance (GitHub MCP, docs, errors, etc.)
For workflow design, creation, updates, debugging, or upgrades, load `.github/skills/agentic-workflows/SKILL.md`.