Skip to content

Commit 4e7344c

Browse files
javimoschSuperCLI Dev
andauthored
automaintainer: Improve supercli static documentation: README, CONTRIBUTING… (#187)
* docs: clarify CONTRIBUTING prerequisites and plugin dev section Add bun to prerequisites (used by description enhancement pipeline scripts) with note that it is optional. Expand plugin development section with the isolated file convention directory tree and explicit warning not to edit shared files — new contributors frequently miss this constraint. * docs: replace confusing install example in README with practical workflow The Node.js install section showed 'npx supercli uuid self generate' which is a UUID utility command, not a useful first-run experience. Replace with 'skills list' which immediately demonstrates supercli's core value: querying the 5000+ plugin catalog. * docs: add server-plugins-usage-guide to features index The server-plugins-usage-guide.md file exists in docs/ but was not linked from the features index, making it undiscoverable for users browsing the feature documentation. Add it to the feature index table. --------- Co-authored-by: SuperCLI Dev <dev@supercli.dev>
1 parent e0f2277 commit 4e7344c

3 files changed

Lines changed: 14 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Before contributing, ensure you have:
2121
- [Node.js](https://nodejs.org/) (LTS version recommended)
2222
- [npm](https://www.npmjs.com/) or [pnpm](https://pnpm.io/)
2323
- Git for version control
24+
- [bun](https://bun.sh/) (optional, only needed for description enhancement pipeline scripts)
2425
- Any CLI tools you want to create plugins for
2526

2627
### Setting Up Your Development Environment
@@ -232,7 +233,16 @@ When creating or updating plugins:
232233

233234
### Want to Create a New Plugin?
234235

235-
New bundled plugins use an **isolated file convention** — no shared file edits needed.
236+
New bundled plugins use an **isolated file convention** — create files ONLY inside `plugins/<name>/`. Never edit `plugins/plugins.json` or `cli/plugin-install-guidance.js` for new plugins.
237+
238+
```
239+
plugins/my-plugin/
240+
├── plugin.json # Required: manifest with commands
241+
├── meta.json # Required: description, tags, has_learn
242+
├── install-guidance.json # Optional: install steps
243+
├── skills/quickstart/SKILL.md # Optional: agent guide
244+
└── README.md # Optional: human docs
245+
```
236246

237247
See our detailed [Plugin Harness Development Guide](docs/plugins-how-to.md) for:
238248

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,8 +329,8 @@ curl -sSL https://github.com/javimosch/supercli/releases/download/v0.1.0-zig/ins
329329
### Option 2: Node.js Version (npx/npm)
330330

331331
```bash
332-
# Run immediately
333-
npx supercli uuid self generate
332+
# Run immediately — no install needed
333+
npx supercli skills list
334334

335335
# Install globally
336336
npm install -g superacli

docs/features/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Detailed documentation for supercli's core features and capabilities.
1717
| [Config Sync](config-sync.md) | Configuration synchronization between client and server | [Read →](config-sync.md) |
1818
| [Execution Plans](execution-plans.md) | Planning and execution of command sequences | [Read →](execution-plans.md) |
1919
| [Azure DevOps & UiPath Plugins](azd-uipath-plugins.md) | Azure Developer CLI and UiPath automation harnesses | [Read →](azd-uipath-plugins.md) |
20+
| [Server Plugins Usage Guide](../server-plugins-usage-guide.md) | Manual testing of server plugins including JSON and ZIP flows | [Read →](../server-plugins-usage-guide.md) |
2021

2122
## Quick Navigation
2223

0 commit comments

Comments
 (0)