You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/commands.md
+36-36Lines changed: 36 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,41 @@ gh aw run weekly-research # Execute workflow
17
17
gh aw logs weekly-research # View execution logs
18
18
```
19
19
20
-
## 🔧 Workflow Compilation
20
+
## 📝 Workflow Creation and Management
21
+
22
+
The `add` and `new` commands help you create and manage agentic workflows, from templates and samples to completely custom workflows.
23
+
24
+
**Creating New Workflows:**
25
+
```bash
26
+
# Create a new workflow with comprehensive template
27
+
gh aw new my-custom-workflow
28
+
29
+
# Create a new workflow, overwriting if it exists
30
+
gh aw new issue-handler --force
31
+
```
32
+
33
+
**Adding Workflows from Samples:**
34
+
```bash
35
+
# Add a workflow from the official samples repository
36
+
gh aw add samples/weekly-research.md -r githubnext/agentics
37
+
38
+
# Add workflow and create pull request for review
39
+
gh aw add samples/issue-triage.md -r githubnext/agentics --pr
40
+
41
+
# Add workflow to a specific directory
42
+
gh aw add samples/daily-standup.md -r githubnext/agentics --output .github/workflows/
43
+
```
44
+
45
+
**Workflow Removal:**
46
+
```bash
47
+
# Remove a workflow and its compiled version
48
+
gh aw remove WorkflowName
49
+
50
+
# Remove workflow but keep shared include files
51
+
gh aw remove WorkflowName --keep-orphans
52
+
```
53
+
54
+
## 🔧 Workflow Recompilation
21
55
22
56
The `compile` command transforms natural language workflow markdown files into executable GitHub Actions YAML files. This is the core functionality that converts your agentic workflow descriptions into automated GitHub workflows.
23
57
@@ -61,48 +95,14 @@ gh aw compile --watch --auto-compile --verbose
61
95
- Generates `.lock.yml` files ready for GitHub Actions execution
62
96
- Integrates with AI engines (Claude, Codex) for instruction processing
63
97
64
-
## 📝 Workflow Creation and Management
65
-
66
-
The `add` and `new` commands help you create and manage agentic workflows, from templates and samples to completely custom workflows.
67
-
68
-
**Adding Workflows from Samples:**
69
-
```bash
70
-
# Add a workflow from the official samples repository
71
-
gh aw add samples/weekly-research.md -r githubnext/agentics
72
-
73
-
# Add workflow and create pull request for review
74
-
gh aw add samples/issue-triage.md -r githubnext/agentics --pr
75
-
76
-
# Add workflow to a specific directory
77
-
gh aw add samples/daily-standup.md -r githubnext/agentics --output .github/workflows/
78
-
```
79
-
80
-
**Creating New Workflows:**
81
-
```bash
82
-
# Create a new workflow with comprehensive template
83
-
gh aw new my-custom-workflow
84
-
85
-
# Create a new workflow, overwriting if it exists
86
-
gh aw new issue-handler --force
87
-
```
88
-
89
-
**Workflow Removal:**
90
-
```bash
91
-
# Remove a workflow and its compiled version
92
-
gh aw remove WorkflowName
93
-
94
-
# Remove workflow but keep shared include files
95
-
gh aw remove WorkflowName --keep-orphans
96
-
```
97
-
98
98
**Creation Features:**
99
99
-**Template Generation**: `new` creates comprehensive markdown with all configuration options
100
100
-**Sample Integration**: `add` pulls proven workflows from community repositories
101
101
-**Pull Request Workflow**: Automatic PR creation for team review processes
102
102
-**Flexible Output**: Control where workflows are created in your repository
103
103
-**Include Management**: Smart handling of shared workflow components
104
104
105
-
## ⚙️ Workflow Operations
105
+
## ⚙️ Workflow Operations on GitHub Actions
106
106
107
107
These commands control the execution and state of your compiled agentic workflows within GitHub Actions.
0 commit comments