Skip to content

Commit a577a24

Browse files
Update CLI reference for features from Oct 26, 2025 (#2589)
1 parent 63437f3 commit a577a24

File tree

1 file changed

+23
-3
lines changed
  • docs/src/content/docs/tools

1 file changed

+23
-3
lines changed

docs/src/content/docs/tools/cli.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,27 @@ Debug logs show:
7676
- Use `--verbose` for user-facing operational details
7777
- Debug logs are zero-overhead when disabled (no performance impact)
7878

79-
## 📝 Workflow Creation and Management
79+
## 📝 Workflow Creation and Management
8080

8181
The `add` and `new` commands help you create and manage agentic workflows, from templates and samples to completely custom workflows.
8282

83-
The `init` command prepares your repository for agentic workflows by configuring `.gitattributes` and creating GitHub Copilot custom instructions.
83+
### Repository Initialization
84+
85+
The `init` command prepares your repository for agentic workflows by configuring `.gitattributes` and creating GitHub Copilot custom instructions:
86+
87+
```bash
88+
gh aw init
89+
```
90+
91+
After initialization, start a chat with an AI agent and use the following prompt to create a new workflow:
92+
93+
```
94+
activate @.github/prompts/create-agentic-workflow.prompt.md
95+
```
96+
97+
Alternatively, add pre-built workflows from the catalog using `gh aw add <workflow-name>`.
98+
99+
### Workflow Management
84100

85101
```bash
86102
# Create new workflows
@@ -127,7 +143,7 @@ Transforms markdown workflow files into executable GitHub Actions YAML files:
127143
# Core compilation
128144
gh aw compile # Compile all workflows
129145
gh aw compile ci-doctor daily-plan # Compile specific workflows
130-
gh aw compile --validate --no-emit # Validate without generating files
146+
gh aw compile --validate --no-emit # Validate schema and containers without generating files
131147
gh aw compile --strict --engine copilot # Strict mode with custom engine
132148
gh aw compile --purge # Remove orphaned .lock.yml files
133149

@@ -140,6 +156,10 @@ gh aw compile --dependabot # Generate dependency manifests
140156
gh aw compile --dependabot --force # Force overwrite existing files
141157
```
142158

159+
**Validation:**
160+
161+
The `--validate` flag enables GitHub Actions workflow schema validation and container image validation. By default, validation is disabled for faster compilation. Enable it when you need to verify workflow correctness or validate that container images exist and are accessible.
162+
143163
**Strict Mode:**
144164

145165
Enables enhanced security validation requiring timeouts, explicit network configuration, and blocking write permissions. Use `--strict` flag or `strict: true` in frontmatter.

0 commit comments

Comments
 (0)