Skip to content

Commit 10921be

Browse files
Copilotalexec
andcommitted
Update documentation examples to use slash commands instead of task names
Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
1 parent 503d3f4 commit 10921be

11 files changed

Lines changed: 132 additions & 132 deletions

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ sudo chmod +x /usr/local/bin/coding-context
7979

8080
```
8181
Usage:
82-
coding-context [options] <task-name>
82+
coding-context [options] <task-prompt>
8383
8484
Options:
8585
-C string
@@ -100,7 +100,7 @@ Options:
100100

101101
**Basic usage with local files:**
102102
```bash
103-
coding-context -p jira_issue_key=PROJ-1234 fix-bug | llm -m gemini-pro
103+
coding-context -p jira_issue_key=PROJ-1234 /fix-bug | llm -m gemini-pro
104104
```
105105

106106
This command will:
@@ -117,7 +117,7 @@ This command will:
117117
coding-context \
118118
-d git::https://github.com/company/shared-rules.git \
119119
-d s3::https://s3.amazonaws.com/my-bucket/coding-standards \
120-
fix-bug | llm -m gemini-pro
120+
/fix-bug | llm -m gemini-pro
121121
```
122122

123123
This command will:
@@ -192,19 +192,19 @@ The tool supports loading rules and tasks from remote locations via HTTP/HTTPS U
192192

193193
```bash
194194
# Clone a Git repository containing rules
195-
coding-context -d git::https://github.com/company/shared-rules.git fix-bug
195+
coding-context -d git::https://github.com/company/shared-rules.git /fix-bug
196196

197197
# Use multiple remote sources
198198
coding-context \
199199
-d git::https://github.com/company/shared-rules.git \
200200
-d https://cdn.company.com/coding-standards \
201-
deploy
201+
/deploy
202202

203203
# Mix local and remote directories
204204
coding-context \
205205
-d git::https://github.com/company/shared-rules.git \
206206
-s language=Go \
207-
implement-feature
207+
/implement-feature
208208
```
209209

210210
**Supported protocols (via go-getter):**
@@ -226,12 +226,12 @@ coding-context \
226226
# Use a specific branch or tag
227227
coding-context \
228228
-d 'git::https://github.com/company/shared-rules.git?ref=v1.0' \
229-
fix-bug
229+
/fix-bug
230230

231231
# Use a subdirectory within the repo
232232
coding-context \
233233
-d 'git::https://github.com/company/mono-repo.git//coding-standards' \
234-
implement-feature
234+
/implement-feature
235235
```
236236

237237
## File Formats
@@ -275,10 +275,10 @@ Deploy the application to production with all safety checks.
275275
You can then select the appropriate task using:
276276
```bash
277277
# Deploy to staging
278-
coding-context -s environment=staging deploy
278+
coding-context -s environment=staging /deploy
279279

280280
# Deploy to production
281-
coding-context -s environment=production deploy
281+
coding-context -s environment=production /deploy
282282
```
283283

284284
#### Task Frontmatter Selectors
@@ -301,12 +301,12 @@ Implement the feature following Go best practices and implementation guidelines.
301301
When you run this task, it automatically applies the selectors:
302302
```bash
303303
# This command automatically includes only rules with language=Go and stage=implementation
304-
coding-context implement-feature
304+
coding-context /implement-feature
305305
```
306306

307307
This is equivalent to:
308308
```bash
309-
coding-context -s language=Go -s stage=implementation implement-feature
309+
coding-context -s language=Go -s stage=implementation /implement-feature
310310
```
311311

312312
**Selectors support OR logic for the same key using arrays:**
@@ -328,7 +328,7 @@ Selectors from both the task frontmatter and command line are combined (additive
328328
# Task has: selectors.language = Go
329329
# Command adds: -s priority=high
330330
# Result: includes rules matching language=Go AND priority=high
331-
coding-context -s priority=high implement-feature
331+
coding-context -s priority=high /implement-feature
332332
```
333333

334334
### Resume Mode
@@ -348,10 +348,10 @@ This is particularly useful in agentic workflows where an AI agent has already b
348348

349349
```bash
350350
# Initial task invocation (includes all rules, uses task with resume: false)
351-
coding-context -s resume=false fix-bug | ai-agent
351+
coding-context -s resume=false /fix-bug | ai-agent
352352

353353
# Resume the task (skips rules, uses task with resume: true)
354-
coding-context -r fix-bug | ai-agent
354+
coding-context -r /fix-bug | ai-agent
355355
```
356356

357357
**Example task files for resume mode:**
@@ -401,7 +401,7 @@ language: Go
401401
To include this rule only when working on Go code, you would use `-s language=Go`:
402402

403403
```bash
404-
coding-context -s language=Go fix-bug
404+
coding-context -s language=Go /fix-bug
405405
```
406406

407407
This will include all rules with `language: Go` in their frontmatter, excluding rules for other languages.
@@ -418,10 +418,10 @@ Then select only the relevant rules:
418418

419419
```bash
420420
# Work on Python code with Python-specific rules
421-
coding-context -s language=Python fix-bug
421+
coding-context -s language=Python /fix-bug
422422

423423
# Work on JavaScript code with JavaScript-specific rules
424-
coding-context -s language=JavaScript enhance-feature
424+
coding-context -s language=JavaScript /enhance-feature
425425
```
426426

427427
**Common Linguist Languages**
@@ -480,7 +480,7 @@ When working with a specific AI coding agent, the agent itself will read its own
480480
```bash
481481
# When using Cursor, exclude .cursor/ and .cursorrules (Cursor reads those itself)
482482
# But include rules from other agents and generic rules
483-
coding-context -a cursor fix-bug
483+
coding-context -a cursor /fix-bug
484484
```
485485

486486
**How it works:**
@@ -546,7 +546,7 @@ Task frontmatter is automatically included at the beginning of the output. This
546546

547547
**Example usage:**
548548
```bash
549-
coding-context -p issue_number=123 fix-bug
549+
coding-context -p issue_number=123 /fix-bug
550550
```
551551

552552
**Output format:**
@@ -567,7 +567,7 @@ This can be useful for:
567567

568568
**Example with selectors in frontmatter:**
569569
```bash
570-
coding-context implement-feature
570+
coding-context /implement-feature
571571
```
572572

573573
If the task has `selectors` in its frontmatter, they will be visible in the output:

docs/explanation/agentic-workflows.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ Context is assembled at runtime based on the specific task:
9191

9292
```bash
9393
# Bug fix: Include only relevant rules
94-
coding-context -s language=Go -s priority=high fix-bug
94+
coding-context -s language=Go -s priority=high /fix-bug
9595

9696
# Code review: Different context
97-
coding-context -s stage=review code-review
97+
coding-context -s stage=review /code-review
9898
```
9999

100100
### 3. Parameter Injection
@@ -106,7 +106,7 @@ Runtime information flows into task prompts:
106106
coding-context \
107107
-p issue_key=BUG-123 \
108108
-p description="Crashes on startup" \
109-
fix-bug
109+
/fix-bug
110110
```
111111

112112
### 4. Bootstrap for Live Data
@@ -116,7 +116,7 @@ Scripts fetch current state before agent execution:
116116
```bash
117117
# Fetch JIRA issue details automatically
118118
export JIRA_ISSUE_KEY="BUG-123"
119-
coding-context fix-bug # Bootstrap fetches latest data
119+
coding-context /fix-bug # Bootstrap fetches latest data
120120
```
121121

122122
## The Agentic Workflow Ecosystem

docs/explanation/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Each stage transforms data before passing it to the next stage.
2424
### 1. Parse Command-Line Arguments
2525

2626
```
27-
coding-context -C /project -s language=Go -p issue=BUG-123 fix-bug
27+
coding-context -C /project -s language=Go -p issue=BUG-123 /fix-bug
2828
```
2929

3030
The CLI parses:
@@ -387,7 +387,7 @@ Multiple selectors use AND logic:
387387

388388
```bash
389389
# Requires BOTH language=Go AND stage=testing
390-
coding-context -s language=Go -s stage=testing fix-bug
390+
coding-context -s language=Go -s stage=testing /fix-bug
391391

392392
# No way to specify: language=Go OR language=Python
393393
```

docs/how-to/create-rules.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ language: Python
6161
Use with:
6262
```bash
6363
# Include only Go rules
64-
coding-context -s language=Go fix-bug
64+
coding-context -s language=Go /fix-bug
6565

6666
# Include only Python rules
67-
coding-context -s language=Python fix-bug
67+
coding-context -s language=Python /fix-bug
6868
```
6969

7070
## Rules with Multiple Selectors
@@ -90,7 +90,7 @@ When writing tests:
9090
Use with:
9191
```bash
9292
# Include rules for Go testing
93-
coding-context -s language=Go -s stage=testing implement-feature
93+
coding-context -s language=Go -s stage=testing /implement-feature
9494
```
9595

9696
## Stage-Specific Rules
@@ -128,10 +128,10 @@ stage: implementation
128128
Use with:
129129
```bash
130130
# Planning phase
131-
coding-context -s stage=planning plan-feature
131+
coding-context -s stage=planning /plan-feature
132132

133133
# Implementation phase
134-
coding-context -s stage=implementation implement-feature
134+
coding-context -s stage=implementation /implement-feature
135135
```
136136

137137
## Rules with Bootstrap Scripts
@@ -172,7 +172,7 @@ Use with:
172172
export JIRA_ISSUE_KEY="PROJ-123"
173173
export JIRA_API_TOKEN="your-token"
174174

175-
coding-context -s source=jira fix-bug
175+
coding-context -s source=jira /fix-bug
176176
```
177177

178178
## Best Practices

docs/how-to/github-actions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
-s stage=review \
4848
-p pr_number=${{ github.event.pull_request.number }} \
4949
-p pr_title="${{ github.event.pull_request.title }}" \
50-
code-review > context.txt
50+
/code-review > context.txt
5151
5252
- name: Review with AI
5353
run: |
@@ -96,7 +96,7 @@ jobs:
9696
-p issue_number=${{ github.event.issue.number }} \
9797
-p issue_title="${{ github.event.issue.title }}" \
9898
-p issue_body="${{ github.event.issue.body }}" \
99-
fix-bug > context.txt
99+
/fix-bug > context.txt
100100
101101
- name: Apply AI Fix
102102
run: |
@@ -132,7 +132,7 @@ jobs:
132132
133133
- name: Planning Context
134134
run: |
135-
coding-context -s stage=planning plan-feature > plan-context.txt
135+
coding-context -s stage=planning /plan-feature > plan-context.txt
136136
137137
- name: Create Plan
138138
run: cat plan-context.txt | your-ai-agent > plan.md
@@ -162,7 +162,7 @@ jobs:
162162

163163
- name: Implementation Context
164164
run: |
165-
coding-context -s stage=implementation implement-feature > impl-context.txt
165+
coding-context -s stage=implementation /implement-feature > impl-context.txt
166166
167167
- name: Implement
168168
run: |
@@ -179,7 +179,7 @@ Pass secrets to bootstrap scripts:
179179
JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
180180
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
181181
run: |
182-
coding-context -s source=jira fix-bug > context.txt
182+
coding-context -s source=jira /fix-bug > context.txt
183183
```
184184
185185
## Caching CLI Binary
@@ -209,7 +209,7 @@ Use the `-C` flag to run from a different directory:
209209
```yaml
210210
- name: Assemble Context
211211
run: |
212-
coding-context -C ./backend -s language=Go fix-bug > context.txt
212+
coding-context -C ./backend -s language=Go /fix-bug > context.txt
213213
```
214214

215215
## Best Practices

0 commit comments

Comments
 (0)