incur 0.0.0 → 0.0.2
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/LICENSE +21 -0
- package/README.md +141 -0
- package/SKILL.md +664 -0
- package/dist/Cli.d.ts +255 -0
- package/dist/Cli.d.ts.map +1 -0
- package/dist/Cli.js +900 -0
- package/dist/Cli.js.map +1 -0
- package/dist/Errors.d.ts +92 -0
- package/dist/Errors.d.ts.map +1 -0
- package/dist/Errors.js +75 -0
- package/dist/Errors.js.map +1 -0
- package/dist/Formatter.d.ts +5 -0
- package/dist/Formatter.d.ts.map +1 -0
- package/dist/Formatter.js +91 -0
- package/dist/Formatter.js.map +1 -0
- package/dist/Help.d.ts +53 -0
- package/dist/Help.d.ts.map +1 -0
- package/dist/Help.js +231 -0
- package/dist/Help.js.map +1 -0
- package/dist/Mcp.d.ts +13 -0
- package/dist/Mcp.d.ts.map +1 -0
- package/dist/Mcp.js +140 -0
- package/dist/Mcp.js.map +1 -0
- package/dist/Parser.d.ts +24 -0
- package/dist/Parser.d.ts.map +1 -0
- package/dist/Parser.js +215 -0
- package/dist/Parser.js.map +1 -0
- package/dist/Register.d.ts +19 -0
- package/dist/Register.d.ts.map +1 -0
- package/dist/Register.js +2 -0
- package/dist/Register.js.map +1 -0
- package/dist/Schema.d.ts +4 -0
- package/dist/Schema.d.ts.map +1 -0
- package/dist/Schema.js +8 -0
- package/dist/Schema.js.map +1 -0
- package/dist/Skill.d.ts +29 -0
- package/dist/Skill.d.ts.map +1 -0
- package/dist/Skill.js +196 -0
- package/dist/Skill.js.map +1 -0
- package/dist/Skillgen.d.ts +3 -0
- package/dist/Skillgen.d.ts.map +1 -0
- package/dist/Skillgen.js +67 -0
- package/dist/Skillgen.js.map +1 -0
- package/dist/SyncMcp.d.ts +23 -0
- package/dist/SyncMcp.d.ts.map +1 -0
- package/dist/SyncMcp.js +100 -0
- package/dist/SyncMcp.js.map +1 -0
- package/dist/SyncSkills.d.ts +38 -0
- package/dist/SyncSkills.d.ts.map +1 -0
- package/dist/SyncSkills.js +163 -0
- package/dist/SyncSkills.js.map +1 -0
- package/dist/Typegen.d.ts +6 -0
- package/dist/Typegen.d.ts.map +1 -0
- package/dist/Typegen.js +92 -0
- package/dist/Typegen.js.map +1 -0
- package/dist/bin.d.ts +14 -0
- package/dist/bin.d.ts.map +1 -0
- package/dist/bin.js +30 -0
- package/dist/bin.js.map +1 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +14 -0
- package/dist/index.js.map +1 -0
- package/dist/internal/pm.d.ts +3 -0
- package/dist/internal/pm.d.ts.map +1 -0
- package/dist/internal/pm.js +11 -0
- package/dist/internal/pm.js.map +1 -0
- package/dist/internal/types.d.ts +11 -0
- package/dist/internal/types.d.ts.map +1 -0
- package/dist/internal/types.js +2 -0
- package/dist/internal/types.js.map +1 -0
- package/dist/internal/utils.d.ts +8 -0
- package/dist/internal/utils.d.ts.map +1 -0
- package/dist/internal/utils.js +51 -0
- package/dist/internal/utils.js.map +1 -0
- package/examples/npm/cli.ts +180 -0
- package/examples/npm/node_modules/.bin/incur.src +21 -0
- package/examples/npm/node_modules/.bin/tsx +21 -0
- package/examples/npm/package.json +14 -0
- package/examples/npm/tsconfig.json +9 -0
- package/examples/presto/cli.ts +246 -0
- package/examples/presto/node_modules/.bin/incur.src +21 -0
- package/examples/presto/node_modules/.bin/tsx +21 -0
- package/examples/presto/package.json +14 -0
- package/examples/presto/tsconfig.json +9 -0
- package/package.json +53 -2
- package/src/Cli.test-d.ts +135 -0
- package/src/Cli.test.ts +1373 -0
- package/src/Cli.ts +1470 -0
- package/src/Errors.test.ts +96 -0
- package/src/Errors.ts +139 -0
- package/src/Formatter.test.ts +245 -0
- package/src/Formatter.ts +106 -0
- package/src/Help.test.ts +124 -0
- package/src/Help.ts +302 -0
- package/src/Mcp.test.ts +254 -0
- package/src/Mcp.ts +195 -0
- package/src/Parser.test-d.ts +45 -0
- package/src/Parser.test.ts +118 -0
- package/src/Parser.ts +247 -0
- package/src/Register.ts +18 -0
- package/src/Schema.test.ts +125 -0
- package/src/Schema.ts +8 -0
- package/src/Skill.test.ts +293 -0
- package/src/Skill.ts +253 -0
- package/src/Skillgen.ts +66 -0
- package/src/SyncMcp.test.ts +75 -0
- package/src/SyncMcp.ts +132 -0
- package/src/SyncSkills.test.ts +92 -0
- package/src/SyncSkills.ts +205 -0
- package/src/Typegen.test.ts +150 -0
- package/src/Typegen.ts +107 -0
- package/src/bin.ts +33 -0
- package/src/e2e.test.ts +1710 -0
- package/src/index.ts +14 -0
- package/src/internal/pm.test.ts +38 -0
- package/src/internal/pm.ts +8 -0
- package/src/internal/types.ts +22 -0
- package/src/internal/utils.ts +50 -0
- package/src/tsconfig.json +8 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025-present
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# incur
|
|
2
|
+
|
|
3
|
+
Simple CLI framework for agents and humans.
|
|
4
|
+
|
|
5
|
+
## Quickprompt
|
|
6
|
+
|
|
7
|
+
Prompt your agent:
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
# Skills (recommended — lighter on tokens)
|
|
11
|
+
> "Run `npx incur skills add`, then show me what I can do with incur."
|
|
12
|
+
|
|
13
|
+
# MCP
|
|
14
|
+
> "Run `npx incur mcp add`, then show me what I can do with incur."
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Install
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm i incur
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
pnpm i incur
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
bun i incur
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
|
|
33
|
+
### Single-command CLI
|
|
34
|
+
|
|
35
|
+
```ts
|
|
36
|
+
import { Cli, z } from 'incur'
|
|
37
|
+
|
|
38
|
+
Cli.create('greet', {
|
|
39
|
+
description: 'A greeting CLI',
|
|
40
|
+
args: z.object({
|
|
41
|
+
name: z.string().describe('Name to greet'),
|
|
42
|
+
}),
|
|
43
|
+
run({ args }) {
|
|
44
|
+
return { message: `hello ${args.name}` }
|
|
45
|
+
},
|
|
46
|
+
}).serve()
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
$ greet world
|
|
51
|
+
# → message: hello world
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Multi-command CLI
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import { Cli, z } from 'incur'
|
|
58
|
+
|
|
59
|
+
Cli.create('my-cli', {
|
|
60
|
+
description: 'My CLI',
|
|
61
|
+
})
|
|
62
|
+
.command('status', {
|
|
63
|
+
description: 'Show repo status',
|
|
64
|
+
run() {
|
|
65
|
+
return { clean: true }
|
|
66
|
+
},
|
|
67
|
+
})
|
|
68
|
+
.command('install', {
|
|
69
|
+
description: 'Install a package',
|
|
70
|
+
args: z.object({
|
|
71
|
+
package: z.string().optional().describe('Package name'),
|
|
72
|
+
}),
|
|
73
|
+
options: z.object({
|
|
74
|
+
saveDev: z.boolean().optional().describe('Save as dev dependency'),
|
|
75
|
+
}),
|
|
76
|
+
alias: { saveDev: 'D' },
|
|
77
|
+
run({ args }) {
|
|
78
|
+
return { added: 1, packages: 451 }
|
|
79
|
+
},
|
|
80
|
+
})
|
|
81
|
+
.serve()
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
```sh
|
|
85
|
+
$ my-cli status
|
|
86
|
+
# → clean: true
|
|
87
|
+
|
|
88
|
+
$ my-cli install express -D
|
|
89
|
+
# → added: 1
|
|
90
|
+
# → packages: 451
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Sub-command CLI
|
|
94
|
+
|
|
95
|
+
```ts
|
|
96
|
+
const cli = Cli.create('my-cli', { description: 'My CLI' })
|
|
97
|
+
|
|
98
|
+
// Create a `pr` group.
|
|
99
|
+
const pr = Cli.create('pr', { description: 'Pull request commands' }).command('list', {
|
|
100
|
+
description: 'List pull requests',
|
|
101
|
+
options: z.object({
|
|
102
|
+
state: z.enum(['open', 'closed', 'all']).default('open'),
|
|
103
|
+
}),
|
|
104
|
+
run({ options }) {
|
|
105
|
+
return { prs: [], state: options.state }
|
|
106
|
+
},
|
|
107
|
+
})
|
|
108
|
+
|
|
109
|
+
cli
|
|
110
|
+
.command(pr) // Link the `pr` group.
|
|
111
|
+
.serve()
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
```sh
|
|
115
|
+
$ my-cli pr list --state closed
|
|
116
|
+
# → prs: (empty)
|
|
117
|
+
# → state: closed
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Agent discovery
|
|
121
|
+
|
|
122
|
+
Every incur CLI gets built-in agent discovery:
|
|
123
|
+
|
|
124
|
+
```sh
|
|
125
|
+
# Auto-generate and install agent skill files (recommended — lighter on tokens)
|
|
126
|
+
my-cli skills add
|
|
127
|
+
|
|
128
|
+
# Register as an MCP server for your agents
|
|
129
|
+
my-cli mcp add
|
|
130
|
+
|
|
131
|
+
# Output machine-readable manifest
|
|
132
|
+
my-cli --llms
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## API Reference
|
|
136
|
+
|
|
137
|
+
> TODO
|
|
138
|
+
|
|
139
|
+
## License
|
|
140
|
+
|
|
141
|
+
MIT
|