Skip to content

Small docs fixes #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dsyme merged 1 commit into from
Aug 13, 2025
Merged

Small docs fixes #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 0 additions & 6 deletions docs/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,12 +204,6 @@ gh aw list --packages --local
- **Local Storage**: Local packages are stored in `.aw/packages/org/repo/` directory structure
- **Flexible Installation**: Choose between global (shared across projects) or local (project-specific) installations

**Note**: The `disable`, `enable`, and `status` commands require:

- GitHub CLI (`gh`) to be installed and authenticated
- The command to be run from within a git repository
- The workflows to be already updated (`.lock.yml` files must exist)

**Package Installation Requirements:**

- GitHub CLI (`gh`) to be installed and authenticated with access to the target repository
Expand Down
8 changes: 8 additions & 0 deletions docs/secrets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ permissions:
contents: read # GITHUB_TOKEN gets content read access
```

## User-Defined Secrets
You need to define custom secrets in your repository or organization settings to enable usage of your chosen agentic processor. These secrets will be referenced in generated workflows.

### `ANTHROPIC_API_KEY`
- **Purpose**: Claude engine access
- **Required for**: `engine: claude` workflows
Expand All @@ -27,6 +30,11 @@ permissions:
- **Required for**: `engine: codex` workflows
- **Setup**: Add to repository or organization secrets

### `GEMINI_API_KEY`
- **Purpose**: Gemini engine access
- **Required for**: `engine: gemini` workflows
- **Setup**: Add to repository or organization secrets

## Related Documentation

- [Commands](commands.md) - CLI commands for workflow management
Expand Down
9 changes: 5 additions & 4 deletions docs/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,11 @@ tools:
- ❌ Claude-specific tools (ignored)
- ✅ Custom MCP tools (stdio only, see [MCP Guide](mcps.md))

### Other Engines
- ✅ GitHub tools (varies by engine)
- ❌ Claude-specific tools
- Varies: Custom MCP tools (see [MCP Guide](mcps.md))
### Gemini Engine
- ✅ GitHub tools (native support)
- ❌ Claude-specific tools (ignored)
- ❌ Custom MCP tools (ignored)


## Security Considerations

Expand Down