@elisym/husk 0.1.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 +54 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +9980 -0
- package/dist/index.js.map +1 -0
- package/package.json +62 -0
package/README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# @elisym/husk
|
|
2
|
+
|
|
3
|
+
The `husk` CLI - [HUSK](https://github.com/elisymlabs/husk), the HTTP Universal
|
|
4
|
+
Skill Kernel. Turn a folder of agent skills into a working HTTP backend with one
|
|
5
|
+
long-lived [Bun](https://bun.sh) process. No SDK, no rewrite: write a script in
|
|
6
|
+
any language, and HUSK publishes it.
|
|
7
|
+
|
|
8
|
+
```sh
|
|
9
|
+
bun add -g @elisym/husk
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Quick start
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
husk init # create ./skills with a starter skill
|
|
16
|
+
husk serve # serve every skill over HTTP on :3000
|
|
17
|
+
curl -X POST localhost:3000/skills/hello --data 'world'
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Commands
|
|
21
|
+
|
|
22
|
+
| Command | Description |
|
|
23
|
+
| --------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
24
|
+
| `husk serve [dir]` | Serve a folder of skills over HTTP. `--watch` hot-reloads, `--port`, `--host`, `--concurrency`, `--cors`, `--name`. |
|
|
25
|
+
| `husk list [dir]` | List discovered skills (`--json` for machine output). |
|
|
26
|
+
| `husk call <name>` | Invoke a skill locally without HTTP. `-i/--input` (`-` = stdin, `@file` = file), `-f/--file`, `-o/--out`, `-d/--dir`. |
|
|
27
|
+
| `husk new <name>` | Scaffold a skill. `-l/--lang bash\|python\|ts`, `-d/--dir`. |
|
|
28
|
+
| `husk init [dir]` | Create a project with a `./skills` folder and a starter skill. |
|
|
29
|
+
| `husk build [dir] --docker` | Emit a Dockerfile so the same skills run in a container. |
|
|
30
|
+
|
|
31
|
+
## A skill is a folder
|
|
32
|
+
|
|
33
|
+
```yaml
|
|
34
|
+
# skills/uppercase/SKILL.md
|
|
35
|
+
---
|
|
36
|
+
name: Uppercase
|
|
37
|
+
description: Send any text, get it back in upper case.
|
|
38
|
+
run: ./upper.sh
|
|
39
|
+
---
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
```sh
|
|
43
|
+
# skills/uppercase/upper.sh
|
|
44
|
+
#!/bin/sh
|
|
45
|
+
exec tr 'a-z' 'A-Z'
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
That is the whole skill. See the [HUSK guide](https://github.com/elisymlabs/husk/blob/main/GUIDE.md)
|
|
49
|
+
for the manifest reference, the kernel I/O contract, and deployment patterns.
|
|
50
|
+
|
|
51
|
+
Requires Bun (the server uses `Bun.serve`). The engine itself lives in
|
|
52
|
+
[`@elisym/husk-core`](https://www.npmjs.com/package/@elisym/husk-core).
|
|
53
|
+
|
|
54
|
+
MIT licensed, by [elisym labs](https://github.com/elisymlabs).
|
package/dist/index.d.ts
ADDED