burgee 0.0.0
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 +35 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/package.json +50 -0
package/README.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# burgee
|
|
2
|
+
|
|
3
|
+
**Not yet released.** This version reserves the name; the first working release is
|
|
4
|
+
wave 1 of the roadmap.
|
|
5
|
+
|
|
6
|
+
A **burgee** is the small swallowtail flag a boat flies to say which club or fleet it
|
|
7
|
+
belongs to — a flag of identity, not of instruction. That is what this framework does for
|
|
8
|
+
a command-line program: a command declares itself once, and every surface is that
|
|
9
|
+
declaration read by a different reader.
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
defineCommand() ──▶ manifest ──┬──▶ human help
|
|
13
|
+
├──▶ --json one stable envelope
|
|
14
|
+
├──▶ --schema versioned, JSON-Schema validated
|
|
15
|
+
├──▶ --mcp an MCP server, generated
|
|
16
|
+
├──▶ completions bash · zsh · fish · pwsh
|
|
17
|
+
├──▶ TypeScript types
|
|
18
|
+
└──▶ docs + llms.txt
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Drop-in compatible with both incumbents, graded by **their own test suites** — 1,215
|
|
22
|
+
commander tests and 1,185 yargs tests — with the pass rate published and ratcheting:
|
|
23
|
+
|
|
24
|
+
```js
|
|
25
|
+
- import { Command } from 'commander';
|
|
26
|
+
+ import { Command } from 'burgee/commander';
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
It stays a library you import in one file: no build step, no config, no directory
|
|
30
|
+
convention, no scaffold. A test enforces that.
|
|
31
|
+
|
|
32
|
+
Roadmap, architecture and the 79-requirement floor:
|
|
33
|
+
<https://github.com/ofri-peretz/cli>
|
|
34
|
+
|
|
35
|
+
MIT © Interlace
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const VERSION = "0.0.0";
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "burgee",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "An agent-native CLI framework, drop-in compatible with commander and yargs. One declaration; help, --json, --schema, --mcp and completions all projected from it.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"engines": {
|
|
8
|
+
"node": ">=24"
|
|
9
|
+
},
|
|
10
|
+
"exports": {
|
|
11
|
+
".": {
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"import": "./dist/index.js"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"files": [
|
|
17
|
+
"dist"
|
|
18
|
+
],
|
|
19
|
+
"scripts": {
|
|
20
|
+
"build": "tsc -p tsconfig.build.json",
|
|
21
|
+
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
22
|
+
"test": "vitest run --passWithNoTests",
|
|
23
|
+
"lint": "eslint src"
|
|
24
|
+
},
|
|
25
|
+
"repository": {
|
|
26
|
+
"type": "git",
|
|
27
|
+
"url": "git+https://github.com/ofri-peretz/cli.git",
|
|
28
|
+
"directory": "packages/burgee"
|
|
29
|
+
},
|
|
30
|
+
"homepage": "https://github.com/ofri-peretz/cli#readme",
|
|
31
|
+
"bugs": {
|
|
32
|
+
"url": "https://github.com/ofri-peretz/cli/issues"
|
|
33
|
+
},
|
|
34
|
+
"keywords": [
|
|
35
|
+
"cli",
|
|
36
|
+
"command-line",
|
|
37
|
+
"argv",
|
|
38
|
+
"commander",
|
|
39
|
+
"yargs",
|
|
40
|
+
"mcp",
|
|
41
|
+
"agent",
|
|
42
|
+
"framework"
|
|
43
|
+
],
|
|
44
|
+
"publishConfig": {
|
|
45
|
+
"access": "public"
|
|
46
|
+
},
|
|
47
|
+
"devDependencies": {
|
|
48
|
+
"vitest": "^4.0.0"
|
|
49
|
+
}
|
|
50
|
+
}
|