Skip to content

Commit e5c98ef

Browse files
homanpcursoragent
andauthored
feat: sus init (#18)
* feat: add sus init command with AGENTS.md docs index Replace per-agent-folder skills with compressed AGENTS.md docs index following Vercel's research showing passive context outperforms active skill retrieval (100% vs 79% pass rate). Changes: - Add `sus init` command to configure project settings - Add `sus.json` config file with `agents_md` toggle - Save package docs to `.sus-docs/` directory (flat structure) - Update AGENTS.md with compressed index on add/remove - Remove old per-agent-folder skills logic (AGENT_ROOTS, save_agent_skills) - Add --yes/-y flag for non-interactive init New files: - crates/cli/src/config.rs - sus.json read/write - crates/cli/src/agents_md.rs - AGENTS.md index management - crates/cli/src/commands/init.rs - init command Reference: https://vercel.com/blog/agents-md-outperforms-skills-in-our-agent-evals Co-authored-by: Cursor <cursoragent@cursor.com> * chore: bump version to 0.1.4 Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent b14bfe7 commit e5c98ef

File tree

9 files changed

+725
-263
lines changed

9 files changed

+725
-263
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ members = [
1111
]
1212

1313
[workspace.package]
14-
version = "0.1.3"
14+
version = "0.1.4"
1515
edition = "2021"
1616
authors = ["sus contributors"]
1717
license = "MIT"

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,14 @@ curl -fsSL https://sus-pm.com/install.sh | sh
5050

5151
## usage
5252

53+
### initialize sus
54+
55+
```bash
56+
sus init
57+
```
58+
59+
configures sus for your project. optionally enables AGENTS.md docs index for AI coding agents.
60+
5361
### add packages (with safety checks)
5462

5563
```bash
@@ -112,6 +120,7 @@ sus check lodash
112120
### other commands
113121

114122
```bash
123+
sus init # initialize sus in project
115124
sus add <pkg> # install with safety checks
116125
sus remove <pkg> # uninstall
117126
sus scan # audit current project
@@ -147,11 +156,16 @@ sus scan --json # machine-readable output
147156

148157
---
149158

150-
## agent skills
159+
## AGENTS.md docs index
160+
161+
sus can generate a compressed docs index in your `AGENTS.md` file, following [Vercel's research](https://vercel.com/blog/agents-md-outperforms-skills-in-our-agent-evals) showing that passive context outperforms active skill retrieval (100% vs 79% pass rate in their evals).
151162

152-
sus automatically generates [Agent Skills](https://agentskills.io) for each installed package. skills are saved to your existing coding agent folders (`.cursor/skills/`, `.claude/skills/`, `.windsurf/skills/`, etc.) following the [Agent Skills specification](https://agentskills.io/specification).
163+
run `sus init` to enable this feature. when enabled:
164+
- package documentation is saved to `.sus-docs/`
165+
- `AGENTS.md` is updated with a compressed index pointing to these docs
166+
- your AI agent gets version-matched documentation without needing to invoke skills
153167

154-
each skill includes quick start examples, best practices, gotchas, and capability requirements — so your ai agent can use packages correctly without guessing.
168+
this approach ensures your agent uses retrieval-led reasoning over potentially outdated training data.
155169

156170
---
157171

@@ -181,7 +195,7 @@ each skill includes quick start examples, best practices, gotchas, and capabilit
181195
│ → GET api.sus-pm.com/v1/packages/express │
182196
│ → get pre-computed risk assessment │
183197
│ → install if safe │
184-
│ → generate agent skills
198+
│ → update AGENTS.md docs index
185199
└─────────────────────────────────────────────┘
186200
```
187201

@@ -210,7 +224,7 @@ if you're building an agent that installs packages, sus is for you.
210224
| malware detection |||||
211225
| typosquat detection |||||
212226
| prompt injection detection |||||
213-
| generates agent skills |||||
227+
| AGENTS.md docs index |||||
214228
| built for ai agents |||||
215229

216230
---

0 commit comments

Comments
 (0)