@useorgx/wizard 0.1.10 → 0.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +31 -9
  2. package/dist/cli.js +545 -53
  3. package/dist/cli.js.map +1 -1
  4. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @useorgx/wizard
2
2
 
3
- One-line CLI onboarding for OrgX surfaces.
3
+ One-line CLI onboarding that adds OrgX MCP configs, skills/rules, and companion plugins to your local AI tools.
4
4
 
5
5
  ## Quick Start
6
6
 
@@ -12,24 +12,35 @@ node dist/cli.js --help
12
12
 
13
13
  For local development, use `pnpm dev -- --help`.
14
14
 
15
+ ## What It Changes
16
+
17
+ The wizard modifies local tool configuration only. Depending on the command, it can:
18
+
19
+ - add OrgX MCP server entries to Claude, Cursor, Codex, VS Code, Windsurf, and Zed;
20
+ - install OrgX skills/rules into Cursor and Claude Code;
21
+ - install companion OrgX plugins/rules for Cursor, Claude Code, Codex, and OpenClaw.
22
+
15
23
  ## Commands
16
24
 
17
- - `setup` configures detected automated surfaces and, when OrgX auth is available in an interactive shell, guides workspace selection or creation, optional onboarding extras, and optional Cursor rules or companion plugin installs for detected Cursor, Claude Code, Codex, and OpenClaw hosts. The founder preset preplans plugin installs before it writes standalone skills so plugin-backed hosts do not get duplicate standalone Claude assets in the same run.
25
+ - `setup` adds OrgX MCP configs, skills/rules, and companion plugins/rules to detected AI tools. When OrgX auth is available in an interactive shell, it also guides workspace selection or creation, optional onboarding extras, and optional Cursor rules or companion plugin installs for detected Cursor, Claude Code, Codex, and OpenClaw hosts. The founder preset preplans plugin installs before it writes standalone skills so plugin-backed hosts do not get duplicate standalone Claude assets in the same run.
18
26
  - `surface list` shows supported surfaces and current status.
19
27
  - `surface add <name>` patches a specific surface.
20
28
  - `surface remove <name>` removes OrgX-managed config from a specific surface.
21
- - `mcp add [surface]` and `mcp remove [surface]` manage Claude, Cursor, Codex, VS Code, Windsurf, and Zed MCP entries.
22
- - `plugins list` shows Cursor rules and companion plugin availability and install status for Cursor, Claude Code, Codex, and OpenClaw.
23
- - `plugins add [target...]` installs managed Cursor OrgX rules or managed OrgX companion plugins into Claude Code, Codex, and/or OpenClaw. Claude Code and Codex plugins carry their own OrgX skills, so they become the source of truth for those hosts.
24
- - `plugins remove [target...]` uninstalls managed Cursor OrgX rules or managed OrgX companion plugins from Claude Code, Codex, and/or OpenClaw.
25
- - `uninstall` removes OrgX-managed surface config, Cursor rules and companion plugins, wizard-local auth, and wizard-local setup state. Use `--keep-auth`, `--keep-state`, `--skip-plugins`, or `--skip-surfaces` to preserve specific pieces.
29
+ - `mcp add [surface]` and `mcp remove [surface]` manage OrgX MCP entries in Claude, Cursor, Codex, VS Code, Windsurf, and Zed tool configs.
30
+ - `plugins list` shows Cursor rules and companion plugin/rules availability and install status for Cursor, Claude Code, Codex, and OpenClaw.
31
+ - `plugins add [target...]` installs managed Cursor OrgX rules or managed OrgX companion plugins/rules into Claude Code, Codex, and/or OpenClaw. Claude Code and Codex plugins carry their own OrgX skills, so they become the source of truth for those hosts.
32
+ - `plugins remove [target...]` uninstalls managed Cursor OrgX rules or managed OrgX companion plugins/rules from Claude Code, Codex, and/or OpenClaw.
33
+ - `uninstall` removes OrgX-managed tool config, Cursor rules and companion plugins, wizard-local auth, and wizard-local setup state. Use `--keep-auth`, `--keep-state`, `--skip-plugins`, or `--skip-surfaces` to preserve specific pieces.
26
34
  - `doctor` verifies local config, hosted MCP reachability, npm registry readiness, current-workspace connectivity, local OpenClaw health, and optionally the remote setup status API. Hosted MCP tools are OAuth-scoped inside the client connector, so the wizard does not preflight them with `oxk_` API keys. It exits non-zero when blocking connectivity issues remain.
27
35
  - `auth status` shows the resolved OrgX API key source and verifies it against `POST /api/client/sync`.
28
36
  - `auth login [--base-url <url>]` starts browser pairing against OrgX, waits for approval, saves the returned per-user key to the wizard auth store, and bootstraps OpenClaw auth if OpenClaw is detected. Use `--api-key <oxk_...>` for CI or blocked-browser fallback.
29
37
  - `auth set-key <oxk_...> [--base-url <url>]` verifies a per-user OrgX key, saves it to the wizard auth store, and bootstraps OpenClaw auth if OpenClaw is detected.
30
38
  - `auth clear` removes the wizard-local saved OrgX API key.
31
39
  - `workspace current`, `workspace list`, `workspace create <name>`, and `workspace set-default <id>` inspect and manage OrgX workspaces.
32
- - `skills add [pack...]` writes `.cursor/rules/orgx.md`, generates `.claude/skills/orgx/SKILL.md`, and installs the default OrgX Claude skill packs (`morning-briefing`, `initiative-kickoff`, `bulk-create`, `nightly-recap`) from `useorgx/skills`. If the Claude Code companion plugin is already installed, the wizard skips those overlapping standalone Claude assets and only installs the remaining standalone pieces.
40
+ - `skills add [pack...]` writes OrgX skills/rules into supported local tools: `.cursor/rules/orgx.md`, `.claude/skills/orgx/SKILL.md`, and available OrgX Claude skill packs from `useorgx/skills`. If the Claude Code companion plugin is already installed, the wizard skips those overlapping standalone Claude assets and only installs the remaining standalone pieces.
41
+ - `skills sync [pack...]` recomposes generated skill/rule files from the OrgX-managed core plus any enabled local skill extensions.
42
+ - `skills status` shows local extension files and generated skill files tracked for drift protection.
43
+ - `skills extensions add|edit|enable|disable|list` manages user-editable skill extensions without changing the OrgX-managed core skill source.
33
44
 
34
45
  ## CI Mode
35
46
 
@@ -58,11 +69,22 @@ For local development, use `pnpm dev -- --help`.
58
69
 
59
70
  - `wizard skills add` writes the OrgX Cursor rule file at `.cursor/rules/orgx.md`.
60
71
  - `wizard skills add` also generates a hosted OrgX Claude skill at `.claude/skills/orgx/SKILL.md`.
61
- - The same command installs the four starter OrgX Claude skill packs by pulling their source files from `useorgx/skills`.
72
+ - The same command installs available OrgX Claude skill packs by pulling their source files from `useorgx/skills`; pass specific pack names to limit what is installed.
73
+ - `wizard skills add` and `wizard skills sync` both compose generated outputs from OrgX-managed core skills plus any enabled extension files from the wizard skill-extension store.
62
74
  - When the Claude Code companion plugin is installed, that plugin owns Claude-side OrgX skills and skill sync. In that case `wizard skills add` skips overlapping Claude assets instead of writing duplicate copies.
63
75
  - The Codex companion plugin also bundles its own OrgX skills, so `wizard skills add` does not try to manage Codex skill files at all.
64
76
  - Those generated rules expect artifact proof to use durable sources such as GitHub permalinks, public URLs, or absolute file paths / `file://...`, not OrgX wrapper routes like `/live/...`, `/artifacts/...`, or `/console/...`.
65
77
 
78
+ ## Skill Extensions
79
+
80
+ OrgX core skills are treated as managed upstream content. User behavior lives in sidecar extension files so upgrades can refresh core skills without losing local preferences.
81
+
82
+ - `wizard skills extensions add orgx --content "- Prefer short status updates."` creates a user extension for the hosted OrgX base skill.
83
+ - `wizard skills extensions edit morning-briefing` creates the extension if needed and opens it in `$EDITOR`.
84
+ - `wizard skills sync` appends enabled extensions after the core skill content and writes the composed output into configured tools.
85
+ - Generated skill files are tracked in wizard state. If a generated file is edited by hand after sync, the next sync skips that file unless `--force` is passed. Move durable local behavior into `skills extensions` files instead of editing generated output directly.
86
+ - Extension scopes are `user`, `workspace`, and `project`. Today they are local sidecars; the same shape is intended to map to future OrgX account/workspace sync.
87
+
66
88
  ## Release Flow
67
89
 
68
90
  - GitHub Actions publishes to npm on pushes of version tags matching `v*`.