Skip to content

Commit 7f972f0

Browse files
javimoschSuperCLI Dev
andauthored
automaintainer: Improve supercli static documentation: README, CONTRIBUTING… (#190)
* docs: restructure plugins.md notes into categorized subsections The unstructured bullet list mixed general command notes with plugin-specific details, making it hard to scan. Split into Command Reference, Plugin Manifest Features, and Notable Bundled Plugins sections with tables for quick lookup. * docs: add troubleshooting flowchart to README for faster diagnosis The troubleshooting table lists symptoms and fixes, but users still need to scan the full table to find their issue. A visual decision tree lets readers jump directly to the right fix based on their error message, reducing time to resolution for common issues. * docs: add quick-reference summary table to plugins-available.md The harnesses document lists 20+ tools across 10 categories but lacks an overview table, forcing readers to scan the full page to find what they need. A summary table with category, harness name, and install command gives instant orientation before diving into details. --------- Co-authored-by: SuperCLI Dev <dev@supercli.dev>
1 parent f386bff commit 7f972f0

3 files changed

Lines changed: 80 additions & 18 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,18 @@ Both versions co-exist and share plugin storage at `~/.supercli/plugins/plugins.
353353
| MCP server not connecting | Server not running | Ensure the MCP server process is active and accessible |
354354
| Zig binary not found | Wrong platform binary | Use `npx supercli` (Node.js) as fallback — both share plugin state |
355355

356+
**Quick diagnosis flowchart:**
357+
358+
```
359+
Problem?
360+
├─ "command not found" → Run `npx supercli` (zero-install) or `npm install -g superacli`
361+
├─ "plugin not found" → `supercli plugins explore --name <query>` to search registry
362+
├─ Output not JSON → Add `--json` flag (JSON is default, this forces it)
363+
├─ MCP not connecting → Check server process is running + `SUPERCLI_SERVER` env is set
364+
├─ Zig binary missing → Use `npx supercli` (Node.js fallback, shares plugin state)
365+
└─ Arguments rejected → `supercli inspect <ns> <res> <act>` to see expected schema
366+
```
367+
356368
For detailed debugging: `supercli` returns the full schema (JSON by default). Use `supercli inspect <ns> <res> <act>` to validate arguments before execution.
357369

358370
### Getting Help

docs/plugins-available.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22

33
A comprehensive guide to all currently supported harnesses in supercli, including bundled harnesses, built-in adapters, and popular community harnesses available via the plugin system.
44

5+
## Quick Reference
6+
7+
| Category | Harness | Install |
8+
|----------|---------|---------|
9+
| Task tracking | `beads` | `curl -fsSL https://raw.githubusercontent.com/Dicklesworthstone/beads_rust/main/install.sh \| bash` |
10+
| Workspace | `gwc` | `npm install -g @googleworkspace/cli` |
11+
| Commit tooling | `commiat` | `npm install -g commiat` |
12+
| OpenAPI | Built-in | `supercli openapi <operation-id>` |
13+
| HTTP | Built-in | `supercli http <method> <url>` |
14+
| MCP | Built-in | `supercli mcp add <name> --url <url>` |
15+
| GitHub | `gh` | `supercli plugins install gh` |
16+
| AWS | `aws` | `supercli plugins install aws` |
17+
| Docker | `docker` | `supercli plugins install docker` |
18+
| Kubernetes | `kubectl` | `supercli plugins install kubectl` |
19+
| Terraform | `terraform` | `supercli plugins install terraform` |
20+
| Git | `git` | `supercli plugins install git` |
21+
| npm | `npm` | `supercli plugins install npm` |
22+
| Ollama | `ollama` | `supercli plugins install ollama` |
23+
24+
Run `supercli plugins explore --name <tool>` for the full list of 5,000+ available plugins.
25+
526
## Bundled Harnesses
627

728
These harnesses are included with supercli and require only the underlying CLI tool to be installed.

docs/plugins.md

Lines changed: 47 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,50 @@ supercli plugins install <plugin-name> --on-conflict replace
6464

6565
Default is `fail`.
6666

67-
## Notes
68-
69-
- `plugins list` shows installed plugins.
70-
- `plugins explore` shows discoverable plugins from merged sources: curated registry entries plus bundled manifest auto-discovery.
71-
- `plugins explore` supports filters: `--name`, `--tags`, `--has-learn true|false`, `--installed true|false`, `--source bundled|git`, `--limit <n>`.
72-
- `plugins explore --json` includes `has_learn`, `installed`, and `filters` metadata so agents can prioritize plugins with learning content.
73-
- `plugins learn <name>` prints plugin-provided learning content before or after install.
74-
- `plugins install` supports local path, registry name, and direct remote git manifest installs.
75-
- Plugin manifests can define `learn` content via `learn.text` or `learn.file` (path inside plugin folder).
76-
- Plugin manifests can define `post_install` hooks (`script`, optional `runtime`, optional `timeout_ms`) that execute from the plugin folder after install.
77-
- Plugin manifests can define `install_guidance` so plugin-specific setup guidance does not require core edits in `cli/plugin-install-guidance.js`.
78-
- `agency-agents` is a bundled zero-command plugin. Installing it adds a remote skill-document provider named `agency-agents` and refreshes the local skill-doc catalog.
79-
- `visual-explainer` is a bundled zero-command plugin. Installing it adds a remote skill-document provider named `visual-explainer` sourced from normalized markdown skill documents in `javimosch/visual-explainer` and refreshes the local skill-doc catalog.
80-
- `browser-use` is a bundled hybrid plugin. Installing it auto-registers a `browser-use` MCP server, discovers and binds Browser Use MCP tools into direct `browseruse.tool.*` commands, and installs local Browser Use skill documents from the plugin folder.
81-
- `cocoindex-code` is a bundled hybrid plugin. Installing it auto-registers a local `cocoindex-code` MCP server, exposes fast direct search via `cocoindex.code.search`, keeps `cocoindex.mcp.search` for MCP-native flows, and installs local quickstart skill documents.
82-
- `squirrelscan` is a bundled Docker-backed plugin with broad CLI coverage (`audit`, `crawl`, `analyze`, `report`, `auth`, `config`, `init`, `feedback`, `self`, `skills`) plus passthrough. It lazily builds a pinned local image on first use, then reuses it for fast repeat scans (example: `supercli squirrel audit https://example.com -C quick`).
83-
- `openhands` is a bundled plugin for OpenHands headless workflows (`task run`, `task file`, `task json`) plus passthrough for full CLI coverage.
84-
- `uipathcli` is a bundled plugin for UiPath automation lifecycle wrappers (`project pack`, `project analyze`, `project deploy`) plus passthrough.
67+
## Command Reference
68+
69+
| Command | Description |
70+
|---------|-------------|
71+
| `plugins list` | Show installed plugins |
72+
| `plugins explore` | Show discoverable plugins (merged: registry + bundled manifests) |
73+
| `plugins explore --json` | Includes `has_learn`, `installed`, `filters` metadata for agent prioritization |
74+
| `plugins learn <name>` | Print plugin-provided learning content (before or after install) |
75+
| `plugins install <name>` | Install from local path, registry name, or direct remote git manifest |
76+
77+
### Exploration Filters
78+
79+
```bash
80+
supercli plugins explore --name <query> # Filter by name/description
81+
supercli plugins explore --tags <tag1>,<tag2> # Filter by tags
82+
supercli plugins explore --has-learn true --installed false --source bundled --limit 10 --json
83+
```
84+
85+
## Plugin Manifest Features
86+
87+
- **`learn` content** — Define via `learn.text` (inline) or `learn.file` (path inside plugin folder).
88+
- **`post_install` hooks**`script`, optional `runtime`, optional `timeout_ms`. Execute from the plugin folder after install.
89+
- **`install_guidance`** — Plugin-specific setup guidance without core edits in `cli/plugin-install-guidance.js`.
90+
91+
## Notable Bundled Plugins
92+
93+
### Remote Skill-Document Providers
94+
95+
| Plugin | Type | What It Does |
96+
|--------|------|-------------|
97+
| `agency-agents` | Zero-command | Adds remote skill-doc provider from `msitarzewski/agency-agents` |
98+
| `visual-explainer` | Zero-command | Adds remote skill-doc provider from `javimosch/visual-explainer` (normalized markdown) |
99+
100+
### Hybrid Plugins (MCP + Direct Commands)
101+
102+
| Plugin | What It Does |
103+
|--------|-------------|
104+
| `browser-use` | Auto-registers `browser-use` MCP server, binds MCP tools into `browseruse.tool.*` commands, installs local skill documents |
105+
| `cocoindex-code` | Auto-registers local `cocoindex-code` MCP server, exposes `cocoindex.code.search` for fast direct search, keeps `cocoindex.mcp.search` for MCP-native flows |
106+
107+
### Full-CLI Plugins
108+
109+
| Plugin | CLI Coverage | Notes |
110+
|--------|-------------|-------|
111+
| `squirrelscan` | Docker-backed, broad coverage (`audit`, `crawl`, `analyze`, `report`, `auth`, `config`, `init`, `feedback`, `self`, `skills`) + passthrough | Lazily builds pinned local image on first use for fast repeat scans |
112+
| `openhands` | OpenHands headless workflows (`task run`, `task file`, `task json`) + passthrough | Full CLI coverage |
113+
| `uipathcli` | UiPath automation lifecycle (`project pack`, `project analyze`, `project deploy`) + passthrough | Full CLI coverage |

0 commit comments

Comments
 (0)