@orchid-labs/pluxx 0.1.4 → 0.1.6
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.
- package/README.md +66 -3
- package/dist/cli/behavioral.d.ts +27 -0
- package/dist/cli/behavioral.d.ts.map +1 -0
- package/dist/cli/doctor.d.ts.map +1 -1
- package/dist/cli/index.d.ts.map +1 -1
- package/dist/cli/index.js +1667 -472
- package/dist/cli/init-from-mcp.d.ts.map +1 -1
- package/dist/cli/install.d.ts.map +1 -1
- package/dist/cli/lint.d.ts.map +1 -1
- package/dist/cli/migrate.d.ts.map +1 -1
- package/dist/cli/primitive-summary.d.ts.map +1 -1
- package/dist/cli/publish.d.ts +1 -0
- package/dist/cli/publish.d.ts.map +1 -1
- package/dist/commands.d.ts +3 -0
- package/dist/commands.d.ts.map +1 -1
- package/dist/generators/claude-code/index.d.ts +2 -0
- package/dist/generators/claude-code/index.d.ts.map +1 -1
- package/dist/generators/codex/index.d.ts +1 -0
- package/dist/generators/codex/index.d.ts.map +1 -1
- package/dist/generators/cursor/index.d.ts.map +1 -1
- package/dist/generators/index.d.ts.map +1 -1
- package/dist/generators/opencode/index.d.ts +1 -0
- package/dist/generators/opencode/index.d.ts.map +1 -1
- package/dist/generators/shared/claude-family.d.ts +1 -0
- package/dist/generators/shared/claude-family.d.ts.map +1 -1
- package/dist/index.js +200 -80
- package/dist/permissions.d.ts +1 -1
- package/dist/permissions.d.ts.map +1 -1
- package/dist/schema.d.ts +707 -707
- package/dist/validation/platform-rules.d.ts.map +1 -1
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -1,14 +1,46 @@
|
|
|
1
1
|
# pluxx
|
|
2
2
|
|
|
3
|
-
**
|
|
3
|
+
**Turn a raw MCP into a native plugin across Claude Code, Cursor, Codex, and OpenCode.**
|
|
4
4
|
|
|
5
|
-
Import a raw MCP or an existing host-native plugin, keep one maintained source project, and compile native outputs for **Claude Code, Cursor, Codex, and OpenCode
|
|
5
|
+
Import a raw MCP or an existing host-native plugin, keep one maintained source project, and compile native outputs for **Claude Code, Cursor, Codex, and OpenCode** instead of maintaining four separate plugin codebases.
|
|
6
6
|
|
|
7
|
-
Pluxx is the authoring, maintenance, and compilation layer for
|
|
7
|
+
Pluxx is the authoring, maintenance, and compilation layer for teams that want one source of truth instead of four drifting per-host plugin repos. Start with `init`, or use `pluxx autopilot` when you want the one-shot path.
|
|
8
8
|
|
|
9
|
+
Raw MCP access is usually not enough. Most products still need workflow grouping, stronger instructions, hooks, commands, auth/setup guidance, and honest host-native packaging. Pluxx is the layer that makes that repeatable.
|
|
10
|
+
|
|
11
|
+
- Start here: [docs/start-here.md](./docs/start-here.md)
|
|
9
12
|
- Docs: [docs.pluxx.dev](https://docs.pluxx.dev/)
|
|
10
13
|
- Website: [pluxx.dev](https://pluxx.dev/)
|
|
11
14
|
|
|
15
|
+
## Current Proof
|
|
16
|
+
|
|
17
|
+
If you want the fastest way to see what is already real, start with these:
|
|
18
|
+
|
|
19
|
+
- [Proof and install guide](./docs/proof-and-install.md)
|
|
20
|
+
- the shortest public path to the current demos plus one-command install paths for the released self-hosted plugin
|
|
21
|
+
- [Self-hosted core-four proof](./docs/pluxx-self-hosted-core-four-proof.md)
|
|
22
|
+
- `example/pluxx` rebuilt, installed, and `verify-install` checked across Claude Code, Cursor, Codex, and OpenCode
|
|
23
|
+
- [Docs Ops core-four proof](./docs/docs-ops-core-four-proof.md)
|
|
24
|
+
- the flagship `example/docs-ops` source project rebuilt, installed, `verify-install` checked, and exercised through read-only inspect/rewrite workflows across the official Claude Code, Cursor, Codex, and OpenCode CLIs
|
|
25
|
+
- [Docs Ops live Codex walkthrough](./docs/orchid-docs-ops-codex-walkthrough.md)
|
|
26
|
+
- one maintained `docs-ops` source project compiled into a real Codex plugin and used against Orchid's live Docsalot MCP
|
|
27
|
+
- [Docs Ops authenticated publish path](./docs/docs-ops-authenticated-publish-path.md)
|
|
28
|
+
- the flagship example now separates Orchid's public read-only MCP proof from the private write/publish contract, and the install/runtime gate is mechanically proven
|
|
29
|
+
- [Exa Research Example](./docs/exa-research-example.md)
|
|
30
|
+
- a clean-room Exa-style research operator pack built from one maintained source project, with specialist agents, rich brand metadata, real build/install/verify proof across the core four, and live workflow proof in Claude Code, Codex Desktop, Cursor CLI, and OpenCode CLI
|
|
31
|
+
- [Orchid Accordion before/after rewrite](./example/docs-ops/demo-rewrites/orchid-components-accordion.after.md)
|
|
32
|
+
- concrete output from the flagship docs workflow example
|
|
33
|
+
- [Core-four provider docs audit](./docs/core-four-provider-docs-audit.md)
|
|
34
|
+
- first-party host capability and lifecycle truth for Claude Code, Cursor, Codex, and OpenCode
|
|
35
|
+
- [Firecrawl connector docs-ingestion proof](./docs/strategy/firecrawl-connector-docs-ingestion-proof.md)
|
|
36
|
+
- the first real Firecrawl-backed extraction proof on the fixture set
|
|
37
|
+
- [Docs-ingestion fixture snapshot](./docs/strategy/docs-ingestion-fixture-eval.md)
|
|
38
|
+
- keyed local harness rerun with `baseline`, `local`, and `firecrawl` results recorded side by side
|
|
39
|
+
- [Docs-ingestion scaffold before/after demo](./docs/strategy/docs-ingestion-scaffold-before-after.md)
|
|
40
|
+
- a committed Sumble scaffold delta showing what sourced Firecrawl context changes in real generated files
|
|
41
|
+
|
|
42
|
+
The biggest remaining flagship gap is now a real private publish and rollback run against a safe sandbox authoring target, not basic cross-host workflow proof.
|
|
43
|
+
|
|
12
44
|
## Why Pluxx
|
|
13
45
|
|
|
14
46
|
Every host has different plugin contracts and different places to express the same intent:
|
|
@@ -23,6 +55,21 @@ Every host has different plugin contracts and different places to express the sa
|
|
|
23
55
|
|
|
24
56
|
Without Pluxx, those details drift across multiple repos. With Pluxx, you keep one source project and compile honest host-native outputs.
|
|
25
57
|
|
|
58
|
+
For teams that want the shortest path from raw MCP to something usable, `pluxx autopilot` wraps import, refinement, and build/test flow into one command.
|
|
59
|
+
|
|
60
|
+
The current product focus is the OSS authoring substrate:
|
|
61
|
+
|
|
62
|
+
- import
|
|
63
|
+
- scaffold
|
|
64
|
+
- refine
|
|
65
|
+
- lint
|
|
66
|
+
- doctor
|
|
67
|
+
- eval
|
|
68
|
+
- build
|
|
69
|
+
- test
|
|
70
|
+
- install
|
|
71
|
+
- sync
|
|
72
|
+
|
|
26
73
|
Pluxx is built around an explicit compiler model:
|
|
27
74
|
|
|
28
75
|
- `preserve` when a primitive maps cleanly to a host-native surface
|
|
@@ -57,6 +104,16 @@ npx @orchid-labs/pluxx build
|
|
|
57
104
|
npx @orchid-labs/pluxx test
|
|
58
105
|
```
|
|
59
106
|
|
|
107
|
+
One-shot path:
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
npx @orchid-labs/pluxx autopilot \
|
|
111
|
+
--from-mcp https://example.com/mcp \
|
|
112
|
+
--runner codex \
|
|
113
|
+
--name my-plugin \
|
|
114
|
+
--yes
|
|
115
|
+
```
|
|
116
|
+
|
|
60
117
|
Common output shape:
|
|
61
118
|
|
|
62
119
|
```text
|
|
@@ -149,6 +206,8 @@ Pluxx owns the deterministic scaffold, validation, and host compilation layer. Y
|
|
|
149
206
|
- npm package: `@orchid-labs/pluxx`
|
|
150
207
|
- preferred invocation: `npx @orchid-labs/pluxx ...`
|
|
151
208
|
- global install also works: `npm install -g @orchid-labs/pluxx`
|
|
209
|
+
- check the active global CLI version with: `pluxx --version`
|
|
210
|
+
- upgrade the active global CLI with: `pluxx upgrade`
|
|
152
211
|
- published CLI runtime: Node `>=18`
|
|
153
212
|
- source builds and maintainer workflows also run on Node `>=18`
|
|
154
213
|
|
|
@@ -157,6 +216,10 @@ Pluxx owns the deterministic scaffold, validation, and host compilation layer. Y
|
|
|
157
216
|
- [Getting started](./docs/getting-started.md)
|
|
158
217
|
- [Create a Pluxx plugin](./docs/create-a-pluxx-plugin.md)
|
|
159
218
|
- [How it works](./docs/how-it-works.md)
|
|
219
|
+
- [Self-hosted core-four proof](./docs/pluxx-self-hosted-core-four-proof.md)
|
|
220
|
+
- [Docs Ops core-four proof](./docs/docs-ops-core-four-proof.md)
|
|
221
|
+
- [Proof and install guide](./docs/proof-and-install.md)
|
|
222
|
+
- [Docs Ops Codex walkthrough](./docs/orchid-docs-ops-codex-walkthrough.md)
|
|
160
223
|
- [Use Pluxx in host agents](./docs/use-pluxx-in-host-agents.md)
|
|
161
224
|
- [Core primitives](./docs/core-primitives.md)
|
|
162
225
|
- [OSS wedge and trust layer](./docs/oss-wedge-and-trust-layer.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { PluginConfig, TargetPlatform } from '../schema';
|
|
2
|
+
declare const SUPPORTED_PLATFORMS: readonly ["claude-code", "cursor", "codex", "opencode"];
|
|
3
|
+
type BehavioralPlatform = typeof SUPPORTED_PLATFORMS[number];
|
|
4
|
+
export interface BehavioralSuiteOptions {
|
|
5
|
+
promptOverride?: string;
|
|
6
|
+
}
|
|
7
|
+
export interface BehavioralCheckResult {
|
|
8
|
+
caseName: string;
|
|
9
|
+
platform: BehavioralPlatform;
|
|
10
|
+
prompt: string;
|
|
11
|
+
command: string[];
|
|
12
|
+
ok: boolean;
|
|
13
|
+
exitCode: number;
|
|
14
|
+
responseBytes: number;
|
|
15
|
+
responsePreview: string;
|
|
16
|
+
require?: string[];
|
|
17
|
+
forbid?: string[];
|
|
18
|
+
failures: string[];
|
|
19
|
+
}
|
|
20
|
+
export interface BehavioralSuiteResult {
|
|
21
|
+
ok: boolean;
|
|
22
|
+
source: string;
|
|
23
|
+
checks: BehavioralCheckResult[];
|
|
24
|
+
}
|
|
25
|
+
export declare function runBehavioralSuite(rootDir: string, config: PluginConfig, targets: TargetPlatform[], options?: BehavioralSuiteOptions): Promise<BehavioralSuiteResult>;
|
|
26
|
+
export {};
|
|
27
|
+
//# sourceMappingURL=behavioral.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"behavioral.d.ts","sourceRoot":"","sources":["../../src/cli/behavioral.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAI7D,QAAA,MAAM,mBAAmB,yDAA8F,CAAA;AAEvH,KAAK,kBAAkB,GAAG,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAA;AAiB5D,MAAM,WAAW,sBAAsB;IACrC,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,kBAAkB,CAAA;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,EAAE,EAAE,OAAO,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,OAAO,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,qBAAqB,EAAE,CAAA;CAChC;AAED,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,cAAc,EAAE,EACzB,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,qBAAqB,CAAC,CAqBhC"}
|
package/dist/cli/doctor.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"doctor.d.ts","sourceRoot":"","sources":["../../src/cli/doctor.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"doctor.d.ts","sourceRoot":"","sources":["../../src/cli/doctor.ts"],"names":[],"mappings":"AAQA,OAAO,EAAuE,KAAK,2BAA2B,EAAE,MAAM,qBAAqB,CAAA;AAE3I,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;AAElE,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,WAAW,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,OAAO,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,gBAAgB,CAAC,EAAE,2BAA2B,CAAA;CAC/C;AAshCD,wBAAsB,cAAc,CAAC,OAAO,GAAE,MAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CA2D3F;AAED,wBAAsB,aAAa,CAAC,OAAO,GAAE,MAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CAgF1F;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAyB5D"}
|
package/dist/cli/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":";AAKA,OAAO,EAeL,KAAK,mBAAmB,EAIzB,MAAM,SAAS,CAAA;AAkChB,OAAO,EACL,wBAAwB,EAIzB,MAAM,mBAAmB,CAAA;AAG1B,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAkB,MAAM,WAAW,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":";AAKA,OAAO,EAeL,KAAK,mBAAmB,EAIzB,MAAM,SAAS,CAAA;AAkChB,OAAO,EACL,wBAAwB,EAIzB,MAAM,mBAAmB,CAAA;AAG1B,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAkB,MAAM,WAAW,CAAA;AAoCnE,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,OAAO,CAAA;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,cAAc,CAAC,EAAE,mBAAmB,CAAA;IACpC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,OAAO,CAAA;IACrB,eAAe,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,OAAO,CAAA;CACpB;AA2GD,wBAAsB,IAAI,kBAsEzB;AAsjBD,UAAU,mBAAmB;IAC3B,EAAE,EAAE,QAAQ,GAAG,eAAe,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAyBD,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAG9E;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAOhF;AAED,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,SAAS,EACjB,cAAc,CAAC,EAAE,UAAU,CAAC,OAAO,wBAAwB,CAAC,GAAG,IAAI,GAClE,mBAAmB,GAAG,IAAI,CA4B5B;AA+BD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,UAAU,GAAG,YAAY,CAAC,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAUpI;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,cAAc,CAAC,GAAG,OAAO,GAAG,SAAS,CAwCpJ;AAiSD,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAwB3H"}
|