Skip to content

Commit 91ddc88

Browse files
committed
docs: fix command documentation accuracy and add --agent flag docs
1 parent c170137 commit 91ddc88

File tree

4 files changed

+76
-4
lines changed

4 files changed

+76
-4
lines changed

.agent/rules/coding.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
trigger: always_on
3+
---
4+
5+
# Project Rules & Engineering Standards
6+
7+
This document establishes the non-negotiable engineering standards for this project. These rules are designed to maintain codebase health, ensure velocity, and prevent technical debt accumulation.
8+
9+
**All contributors (human and AI) must adhere to these guidelines.**
10+
11+
---
12+
13+
## 1. The Golden Rule: Green Build Policy
14+
> *The main branch must always be in a deployable state.*
15+
16+
* **Passing Tests**: No code may be merged unless **100%** of the project's automated tests (Unit, Integration, E2E) pass.
17+
* **No Broken Windows**: If a build fails, fixing it is the highest priority. No new features can be merged until the build is green.
18+
* **Local Verification**: Before pushing/submitting a PR, you must run the test suite locally. "It works on my machine" is not a valid excuse for CI failures.
19+
20+
## 2. Testing Protocols
21+
> *If it's not tested, it's broken.*
22+
23+
* **Regression Tests**: Every bug fix **MUST** be accompanied by a new test case that reproduces the bug and verifies the fix.
24+
* **New Features**: All new functionality requires corresponding unit tests.
25+
* **Test Quality**:
26+
* Tests must be deterministic (no flaky tests).
27+
* Tests must be readable and test behavior, not implementation details.
28+
29+
## 3. Documentation Hygiene
30+
> *Code is the truth, but documentation is the map.*
31+
32+
* **Atomic Updates**: Documentation updates (README, API docs, inline comments) **MUST** be included in the same Pull Request/Commit as the code change.
33+
* *Example*: If you add a new flag or environment variable, update the configuration guide immediately.
34+
* **Why, Not What**: Comments should explain *why* a decision was made or *why* the logic is complex. Do not write comments that simply repeat what the code does.
35+
* **Obsolescence**: Stale documentation is worse than no documentation. Delete docs that no longer reflect the codebase.
36+
37+
## 4. Code Review & Workflow
38+
* **Small, Atomic Commits**:
39+
* A Change List (CL) or Pull Request (PR) should focus on **one** thing.
40+
* Avoid mixing formatting changes, refactoring, and feature work in the same commit.
41+
* **Conventional Commits**:
42+
* Use semantic commit messages: `feat: ...`, `fix: ...`, `docs: ...`, `refactor: ...`.
43+
* **Linting & Formatting**:
44+
* Code must be formatted automatically (e.g., Prettier, gofmt, Black).
45+
* Zero linting warnings allowed in the final merge.
46+
47+
## 5. Dependency Management
48+
* **Explicit Versions**: All dependencies must be pinned to specific versions (via `package-lock.json`, `go.sum`, `requirements.txt`, etc.).
49+
* **Minimalism**: Do not introduce a heavy library for a trivial utility function that can be written in 5 lines of code.
50+
51+
## 6. AI & Copilot Usage
52+
* **Verification**: Code generated by AI (Cursor, Copilot, ChatGPT) must be reviewed line-by-line.
53+
* **No Hallucinations**: Verify that imported libraries actually exist and APIs are correct.
54+
* **Context**: AI-generated code must match the existing style and patterns of the project.
55+
56+
---
57+
58+
*Modification of these rules requires a consensus from the core engineering team.*

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ ask skill list # View installed skills
138138
| `ask init` | Initialize project, create `ask.yaml` |
139139
| **Skill Management** | |
140140
| `ask skill search <keyword>` | Search skills across all sources |
141-
| `ask skill install <skill...>` | Install skill(s) to `./skills/` |
141+
| `ask skill install <skill...>` | Install skill(s) to `.agent/skills/` |
142142
| `ask skill install skill@v1.0` | Install specific version |
143143
| `ask skill uninstall <skill>` | Remove a skill |
144144
| `ask skill list` | List installed skills |

README_zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ ask skill list # 查看已安装技能
112112
| `ask init` | 初始化项目,创建 `ask.yaml` |
113113
| **技能管理** | |
114114
| `ask skill search <关键词>` | 从所有来源搜索技能 |
115-
| `ask skill install <技能...>` | 安装技能到 `./skills/` |
115+
| `ask skill install <技能...>` | 安装技能到 `.agent/skills/` |
116116
| `ask skill install skill@v1.0` | 安装指定版本 |
117117
| `ask skill uninstall <技能>` | 移除技能 |
118118
| `ask skill list` | 列出已安装技能 |

docs/commands.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ ask skill install <skill> # Install latest version
6767
ask skill install <skill>@v1.0.0 # Install specific version
6868
ask skill install owner/repo # Install from GitHub repo
6969
ask skill install owner/repo/path/to/skill # Install from subdirectory
70+
ask skill install <skill> --agent claude cursor # Install for specific agents
7071
```
7172

7273
**Examples:**
@@ -77,8 +78,12 @@ ask skill install browser-use@v1.2.0 # Specific version
7778
ask skill install anthropics/skills/computer-use # From path
7879
```
7980

81+
**Flags:**
82+
- `--agent, -a`: Install to specific agent(s) (claude, cursor, codex, opencode)
83+
- `--global, -g`: Install to global directory (~/.ask/skills)
84+
8085
**What it does:**
81-
- Downloads the skill to `.agent/skills/<name>/`
86+
- Downloads the skill to `.agent/skills/<name>/` (or agent-specific directories)
8287
- Adds entry to `ask.yaml`
8388
- Records version info in `ask.lock`
8489

@@ -104,9 +109,17 @@ ask skill uninstall <skill>
104109
List all installed skills.
105110

106111
```bash
107-
ask skill list
112+
ask skill list # List project skills
113+
ask skill list --global # List global skills
114+
ask skill list --all # List both project and global
115+
ask skill list --agent claude # List skills for specific agent
108116
```
109117

118+
**Flags:**
119+
- `--agent, -a`: List skills for specific agent(s)
120+
- `--all`: Show both project and global skills
121+
- `--global, -g`: Show global skills only
122+
110123
---
111124

112125
### ask skill info
@@ -200,6 +213,7 @@ ask repo add my-org/skills
200213

201214
Remove a skill source.
202215

216+
```bash
203217
ask repo remove <name>
204218
```
205219

0 commit comments

Comments
 (0)