laurai 0.0.0-stage → 0.1.1
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 +77 -2
- package/dist/cli.js +24434 -0
- package/package.json +56 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Gustavo Biava
|
|
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
CHANGED
|
@@ -1,3 +1,78 @@
|
|
|
1
|
-
|
|
1
|
+
<pre>
|
|
2
|
+
░██ ░███ ░██████
|
|
3
|
+
░██ ░██░██ ░██
|
|
4
|
+
░██ ░██████ ░██ ░██ ░██░████ ░██ ░██ ░██
|
|
5
|
+
░██ ░██ ░██ ░██ ░███ ░█████████ ░██
|
|
6
|
+
░██ ░███████ ░██ ░██ ░██ ░██ ░██ ░██
|
|
7
|
+
░██ ░██ ░██ ░██ ░███ ░██ ░██ ░██ ░██
|
|
8
|
+
░██████████ ░█████░██ ░█████░██ ░██ ░██ ░██ ░██████
|
|
9
|
+
</pre>
|
|
2
10
|
|
|
3
|
-
|
|
11
|
+
# LaurAI
|
|
12
|
+
|
|
13
|
+
Import sets of AI agent Skills into your current folder with a single command.
|
|
14
|
+
|
|
15
|
+
## Quick start
|
|
16
|
+
|
|
17
|
+
There is nothing to install. Run it from the folder you want the Skills in:
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
npx laurai
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
> **Status:** MVP.
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
`npx laurai` is interactive:
|
|
28
|
+
|
|
29
|
+
1. Pick one or more **Agents** (Claude Code, Codex, Opencode, Kilo Code).
|
|
30
|
+
2. Pick one or more **Packs** from the Catalog.
|
|
31
|
+
3. Review the summary and confirm.
|
|
32
|
+
4. The Skills of the chosen Packs are copied into the current directory.
|
|
33
|
+
|
|
34
|
+
Requires Node.js 24 or newer and network access. Behind a corporate proxy, run with `NODE_USE_ENV_PROXY=1` and `HTTPS_PROXY` set.
|
|
35
|
+
|
|
36
|
+
### Where Skills are copied
|
|
37
|
+
|
|
38
|
+
| Agent | Folder |
|
|
39
|
+
| ----------- | ------------------ |
|
|
40
|
+
| Claude Code | `.claude/skills/` |
|
|
41
|
+
| Codex | `.agents/skills/` |
|
|
42
|
+
| Opencode | `.agents/skills/` |
|
|
43
|
+
| Kilo Code | `.agents/skills/` |
|
|
44
|
+
|
|
45
|
+
Nothing is written outside the current directory. If a Skill folder already exists, the CLI asks whether to overwrite or skip it.
|
|
46
|
+
|
|
47
|
+
## How it works
|
|
48
|
+
|
|
49
|
+
The CLI downloads this repository's `main` branch at runtime, so new Skills and Packs are available without a new npm release (see [ADR 0001](docs/adr/0001-fetch-catalog-at-runtime-from-github-main.md)). Everything is validated in a temporary folder first, and the current directory is only written to if the whole import succeeds.
|
|
50
|
+
|
|
51
|
+
## Concepts
|
|
52
|
+
|
|
53
|
+
See [GLOSSARY.md](GLOSSARY.md) for the project language: **Skill**, **Pack**, **Agent**, **Catalog**, **Import**.
|
|
54
|
+
|
|
55
|
+
## Repository layout
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
skills/<name>/SKILL.md Skills
|
|
59
|
+
packs.json The Catalog: Packs, descriptions and their Skills
|
|
60
|
+
src/ The CLI (TypeScript)
|
|
61
|
+
docs/adr/ Architecture decision records
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Development
|
|
65
|
+
|
|
66
|
+
```sh
|
|
67
|
+
npm install
|
|
68
|
+
npm run check # lint, format check, typecheck and tests
|
|
69
|
+
npm run build # bundles everything into dist/cli.js
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Adding content: put a Skill in `skills/<name>/SKILL.md` and list it in a Pack in `packs.json`. Names may only use lowercase letters, digits and hyphens. The tests fail if a Pack lists a Skill that does not exist. Because the CLI downloads `main` at runtime, whatever lands there is what users get.
|
|
73
|
+
|
|
74
|
+
Releases: bump the version with `npm version` and push the `vX.Y.Z` tag. The Release workflow publishes to npm and needs the `NPM_TOKEN` repository secret.
|
|
75
|
+
|
|
76
|
+
## License
|
|
77
|
+
|
|
78
|
+
MIT
|