Skip to content

[spec-extractor] docs: Update package specifications for agentdrain, cli, console, constants #35680

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
pelikhan merged 1 commit into from
May 29, 2026
+15 −10
Merged

[spec-extractor] docs: Update package specifications for agentdrain, cli, console, constants #35680

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
4 changes: 4 additions & 0 deletions pkg/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ All diagnostic output MUST go to `stderr` using `console` formatting helpers. St
| `gh aw secrets` | `NewSecretsCommand` | Manage workflow secrets |
| `gh aw secrets set` | (secret_set_command.go) | Create or update a repository secret |
| `gh aw secrets bootstrap` | (secret_set_command.go) | Validate and configure all required secrets for workflows |
| `gh aw env` | `NewEnvCommand` | Manage compiler defaults as GitHub variables |
| `gh aw env pull` | (env_command.go) | Download compiler defaults into a YAML file |
| `gh aw env push` | (env_command.go) | Upload compiler defaults from a YAML file |
| `gh aw view` | `NewViewCommand` | Render unified timeline and safe outputs for a workflow run |
| `gh aw lint` | `NewLintCommand` | Lint existing `.lock.yml` workflows with actionlint |
| `gh aw experiments` | `NewExperimentsCommand` | Explore ongoing A/B experiments in the repository (hidden) |
| `gh aw experiments list` | `NewExperimentsListSubcommand` | List all experiment workflow branches |
Expand Down
21 changes: 11 additions & 10 deletions pkg/constants/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The package uses typed aliases to prevent mixing unrelated string or integer val

| Type | Description | Example constant |
|------|-------------|-----------------|
| `EngineName` | AI engine identifier | `CopilotEngine`, `ClaudeEngine`, `CodexEngine`, `GeminiEngine`, `OpenCodeEngine`, `CrushEngine`, `PiEngine` |
| `EngineName` | AI engine identifier | `CopilotEngine`, `ClaudeEngine`, `CodexEngine`, `GeminiEngine`, `AntigravityEngine`, `OpenCodeEngine`, `CrushEngine`, `PiEngine` |
| `FeatureFlag` | Feature flag identifier | `MCPGatewayFeatureFlag`, `MCPScriptsFeatureFlag` |
| `JobName` | GitHub Actions job name | `AgentJobName`, `ActivationJobName` |
| `StepID` | GitHub Actions step identifier | `CheckMembershipStepID`, `CheckRateLimitStepID` |
Expand All @@ -45,17 +45,18 @@ All semantic types implement `String() string` and `IsValid() bool` methods.
import "github.com/github/gh-aw/pkg/constants"

// Engine names
constants.CopilotEngine // "copilot"
constants.ClaudeEngine // "claude"
constants.CodexEngine // "codex"
constants.GeminiEngine // "gemini"
constants.OpenCodeEngine // "opencode"
constants.CrushEngine // "crush"
constants.PiEngine // "pi" (experimental)
constants.DefaultEngine // "copilot"
constants.CopilotEngine // "copilot"
constants.ClaudeEngine // "claude"
constants.CodexEngine // "codex"
constants.GeminiEngine // "gemini"
constants.AntigravityEngine // "antigravity"
constants.OpenCodeEngine // "opencode"
constants.CrushEngine // "crush"
constants.PiEngine // "pi" (experimental)
constants.DefaultEngine // "copilot"

// All supported engine names
constants.AgenticEngines // []string{"claude", "codex", "copilot", "gemini", "opencode", "crush", "pi"}
constants.AgenticEngines // []string{"claude", "codex", "copilot", "gemini", "antigravity", "opencode", "crush", "pi"}

// Get engine metadata
opt := constants.GetEngineOption("copilot")
Expand Down
Loading