|
| 1 | +# AWF Skill for Claude Code Agents |
| 2 | + |
| 3 | +This skill enables Claude Code agents to effectively use the AWF (Agentic Workflow Firewall) tool for running commands with network isolation and domain whitelisting. |
| 4 | + |
| 5 | +## What This Skill Provides |
| 6 | + |
| 7 | +- Complete AWF CLI reference and usage patterns |
| 8 | +- Domain whitelisting syntax and best practices |
| 9 | +- Common workflows for GitHub Copilot, MCP servers, Playwright testing |
| 10 | +- Debugging and log analysis commands |
| 11 | +- Troubleshooting guide for common issues |
| 12 | + |
| 13 | +## Installation |
| 14 | + |
| 15 | +### Option 1: Copy to Your Project (Recommended) |
| 16 | + |
| 17 | +Copy the skill directory to your project's `.claude/skills/` folder: |
| 18 | + |
| 19 | +```bash |
| 20 | +# From within your project directory |
| 21 | +mkdir -p .claude/skills |
| 22 | +cp -r /path/to/gh-aw-firewall/.claude/skills/awf-skill .claude/skills/ |
| 23 | +``` |
| 24 | + |
| 25 | +### Option 2: Symlink (Development) |
| 26 | + |
| 27 | +For development, you can symlink to the source: |
| 28 | + |
| 29 | +```bash |
| 30 | +mkdir -p .claude/skills |
| 31 | +ln -s /path/to/gh-aw-firewall/.claude/skills/awf-skill .claude/skills/awf-skill |
| 32 | +``` |
| 33 | + |
| 34 | +### Option 3: Download from GitHub |
| 35 | + |
| 36 | +```bash |
| 37 | +mkdir -p .claude/skills/awf-skill |
| 38 | +curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/skill.md \ |
| 39 | + -o .claude/skills/awf-skill/SKILL.md |
| 40 | +``` |
| 41 | + |
| 42 | +## Prerequisites |
| 43 | + |
| 44 | +Before using this skill, ensure AWF is installed: |
| 45 | + |
| 46 | +```bash |
| 47 | +# Install AWF |
| 48 | +curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/install.sh | sudo bash |
| 49 | + |
| 50 | +# Verify installation |
| 51 | +sudo awf --version |
| 52 | +``` |
| 53 | + |
| 54 | +## Usage |
| 55 | + |
| 56 | +Once installed, the skill is automatically available to Claude Code agents working in your project. The agent can reference this skill when: |
| 57 | + |
| 58 | +- Asked to run commands with network restrictions |
| 59 | +- Troubleshooting network-related issues in agentic workflows |
| 60 | +- Setting up CI/CD pipelines with network isolation |
| 61 | +- Debugging blocked domains or traffic |
| 62 | + |
| 63 | +### Example Agent Interaction |
| 64 | + |
| 65 | +**User**: "Run the test suite with only GitHub domains allowed" |
| 66 | + |
| 67 | +**Agent** (using this skill): |
| 68 | +```bash |
| 69 | +sudo awf --allow-domains github.com,api.github.com -- npm test |
| 70 | +``` |
| 71 | + |
| 72 | +**User**: "The API call to arxiv.org is failing" |
| 73 | + |
| 74 | +**Agent** (using this skill): |
| 75 | +```bash |
| 76 | +# Check what's being blocked |
| 77 | +awf logs --format json | jq 'select(.isAllowed == false)' |
| 78 | + |
| 79 | +# Add the domain |
| 80 | +sudo awf --allow-domains github.com,arxiv.org -- your-command |
| 81 | +``` |
| 82 | + |
| 83 | +## Skill Contents |
| 84 | + |
| 85 | +- `SKILL.md` - Main skill definition with comprehensive AWF documentation |
| 86 | +- `README.md` - This installation and usage guide |
| 87 | + |
| 88 | +## Integration with Other Skills |
| 89 | + |
| 90 | +This skill works well alongside: |
| 91 | + |
| 92 | +- **debug-firewall** - For manual Docker debugging when AWF containers need inspection |
| 93 | +- **awf-debug-tools** - Python scripts for advanced log parsing and diagnostics |
| 94 | + |
| 95 | +## Updating |
| 96 | + |
| 97 | +To update the skill to the latest version: |
| 98 | + |
| 99 | +```bash |
| 100 | +# If copied |
| 101 | +rm -rf .claude/skills/awf-skill |
| 102 | +cp -r /path/to/updated/gh-aw-firewall/.claude/skills/awf-skill .claude/skills/ |
| 103 | + |
| 104 | +# If symlinked |
| 105 | +# Just update the source repository |
| 106 | +cd /path/to/gh-aw-firewall && git pull |
| 107 | +``` |
| 108 | + |
| 109 | +## License |
| 110 | + |
| 111 | +This skill is part of the gh-aw-firewall project and is licensed under MIT. |
0 commit comments