From d8537e67c55440afb1c5a168be8f9092a67d827b Mon Sep 17 00:00:00 2001 From: Christopher Date: Sat, 30 May 2026 11:10:29 +1000 Subject: [PATCH] docs(cli): document allagents status, kind labels, and plugin list Type field - Add `allagents status` to the Top-Level Commands block in cli.mdx - Add a ### status section documenting the plugin/skill classification rule, the per-entry Type label, the `kind` JSON field, and the backward-compatible `allagents workspace status` alias - Add a ### plugin list section documenting the Type/kind distinction - Update quick-start.mdx: replace `allagents workspace status` example with `allagents status` and note the legacy alias still works - Add inline comment in plugin.ts noting that getWorkspaceStatus is filesystem-only (offline: true), so the cost is imperceptible --- .../docs/docs/getting-started/quick-start.mdx | 4 +- docs/src/content/docs/docs/reference/cli.mdx | 48 ++++++++++++++++++- src/cli/commands/plugin.ts | 2 + 3 files changed, 52 insertions(+), 2 deletions(-) diff --git a/docs/src/content/docs/docs/getting-started/quick-start.mdx b/docs/src/content/docs/docs/getting-started/quick-start.mdx index 4d2f226..ef5e062 100644 --- a/docs/src/content/docs/docs/getting-started/quick-start.mdx +++ b/docs/src/content/docs/docs/getting-started/quick-start.mdx @@ -64,5 +64,7 @@ allagents update --scope user ## Check Status ```bash -allagents workspace status +allagents status ``` + +Lists all configured plugins and skills with their availability status and target clients. Each entry shows a `Type` of `plugin` or `skill`. The legacy form `allagents workspace status` is still accepted. diff --git a/docs/src/content/docs/docs/reference/cli.mdx b/docs/src/content/docs/docs/reference/cli.mdx index 545b72e..e205343 100644 --- a/docs/src/content/docs/docs/reference/cli.mdx +++ b/docs/src/content/docs/docs/reference/cli.mdx @@ -7,6 +7,7 @@ description: Complete reference for AllAgents CLI commands. ```bash allagents update [--offline] [--dry-run] [--client ] [--scope ] +allagents status ``` ### update @@ -31,11 +32,37 @@ Sync state is tracked in `.allagents/sync-state.json`. When `vscode` is in the `clients` list, sync also generates a `.code-workspace` file with repository paths resolved to absolute paths. See the [Workspaces guide](/docs/guides/workspaces/#vscode-workspace-generation) for details. +### status + +Show the sync status of all configured plugins and skills. + +```bash +allagents status +``` + +Lists every configured entry with its availability, type, and configured clients. Each entry includes a `Type` label of either `plugin` or `skill`: + +- **plugin** — standard plugin repository (has a `skills/` directory or no `SKILL.md` at the root) +- **skill** — standalone skill repository (root-level `SKILL.md`, no `skills/` subdirectory) + +With `--json`, each entry in the `plugins` array includes a `kind` field (`"plugin"` or `"skill"`): + +```json +{ + "plugins": [ + { "source": "owner/repo", "type": "github", "kind": "skill", "available": true } + ], + "clients": ["claude"] +} +``` + +`allagents workspace status` is accepted as a backwards-compatible alias. + ## Workspace Commands ```bash allagents workspace init [--from ] -allagents workspace status +allagents workspace status # alias for `allagents status` allagents workspace plugin install [--scope ] allagents workspace plugin remove [--scope ] ``` @@ -109,6 +136,25 @@ allagents skill remove [--plugin ] [--scope ] allagents skill add [--from ] [--plugin ] [--scope ] ``` +### plugin list + +List all installed plugins and skills. + +```bash +allagents plugin list +allagents plugin list [marketplace] # filter by marketplace name +``` + +Each entry shows a `Type` label of either `plugin` or `skill` (see [`status`](#status) for the classification rule). With `--json`, each entry includes a `kind` field: + +```json +{ + "plugins": [ + { "spec": "owner/repo", "scope": "user", "kind": "skill", "fileClients": ["claude"] } + ] +} +``` + ### plugin install Install a plugin into the workspace. diff --git a/src/cli/commands/plugin.ts b/src/cli/commands/plugin.ts index 9e8bcc5..9a17b32 100644 --- a/src/cli/commands/plugin.ts +++ b/src/cli/commands/plugin.ts @@ -776,6 +776,8 @@ const pluginListCmd = command({ // Build a source→kind map so each listed entry can be labelled // 'skill' (root SKILL.md, no skills/ subdir) or 'plugin' (everything // else, including not-yet-resolved sources). + // getWorkspaceStatus resolves marketplace specs with { offline: true }, + // so this is filesystem-only and adds ~2ms per plugin — no network I/O. const kindBySource = new Map(); try { const status = await getWorkspaceStatus(process.cwd());