@cremini/skillpack 1.1.4-beta.0 → 1.1.4

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.
Files changed (2) hide show
  1. package/README.md +87 -47
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,83 +1,99 @@
1
- # SkillPack.sh - Pack AI Skills into Local Agents
1
+ # SkillPack.sh — Pack AI Skills into Local Agents
2
2
 
3
3
  Skillpack by Cremini is built on the idea of distributed intelligence, much like cremini mushrooms that grow from a vast, interconnected mycelial network.
4
4
 
5
5
  ## Use Case
6
- The main use case is to **run local agents on your computer and integrate them with Slack or Telegram** so they can work for you and your team—operating entirely on your machine to keep all team data local and private, while continuously improving by learning new skills.
7
6
 
8
- If skills and tools are like LEGO pieces, a skill pack is the master piece that assembles them into a complete solution. Go to [skillpack.sh](https://skillpack.sh) to download skillpacks.Each Skill Pack should organize different skills to address a well-defined problem or complete specific tasks. For example, research a company by gathering information from various sources and create a PowerPoint presentation based on the findings.
7
+ The main use case is to **run local agents on your computer and integrate them with Slack or Telegram** so they can work for you and your team — operating entirely on your machine to keep all team data local and private, while continuously improving by learning new skills.
9
8
 
10
- ## Quick Start
9
+ If skills and tools are like LEGO pieces, a SkillPack is the finished product that assembles them into a complete solution. Go to [skillpack.sh](https://skillpack.sh) to download ready-made packs.
10
+
11
+ Each SkillPack organizes skills around a well-defined job — for example: research a company by gathering information from multiple sources and produce a PowerPoint presentation from the findings.
11
12
 
12
- ### Create a Skill Pack Interactively
13
+ ---
14
+
15
+ ## Quick Start
13
16
 
14
- One command orchestrates [Skills](https://skills.sh) and tools into a Local Agent that users can download and run it on their own computer to get work done. It can also connect to chat platforms like Slack or Telegram, allowing you to easily send instructions to your local agent team anytime.
17
+ ### Create a new pack interactively
15
18
 
16
19
  ```bash
17
20
  npx @cremini/skillpack create
18
21
  ```
19
22
 
20
- Step-by-Step
23
+ Step by step:
21
24
 
22
- 1. Set the Pack name and description
23
- 2. Add skills from a GitHub repos, URLs, or local paths
24
- 3. Add prompts to orchestrate and organize skills you added to accomplish tasks
25
- 4. (Optional) bundle the result as a zip
25
+ 1. Set the pack name and description.
26
+ 2. Add skills from GitHub repos, URLs, or local paths.
27
+ 3. Add prompts to tell the agent how to orchestrate those skills.
28
+ 4. Optionally package the result as a zip immediately.
26
29
 
27
- ### Initialize with Configuration
30
+ ### Initialize from an existing config
28
31
 
29
32
  ```bash
30
- npx @cremini/skillpack init --config ./skillpack.json
31
- npx @cremini/skillpack init commic_explainer --config https://raw.githubusercontent.com/CreminiAI/skillpack/refs/heads/main/examples/commic_explainer.json
33
+ # From a local file
34
+ npx @cremini/skillpack create --config ./skillpack.json
35
+
36
+ # From a remote URL (no directory = current directory)
37
+ npx @cremini/skillpack create comic-explainer --config https://raw.githubusercontent.com/CreminiAI/skillpack/refs/heads/main/examples/comic_explainer.json
32
38
  ```
33
39
 
34
- Bootstrap a SkillPack using a local file or remote URL.
40
+ Downloads and validates the config, installs all declared skills, and copies the start scripts — ready to run in one step.
35
41
 
36
- ### Step-by-Step Commands
42
+ ### Run a pack
37
43
 
38
44
  ```bash
39
- # Add skills
40
- npx @cremini/skillpack skills add vercel-labs/agent-skills --skill frontend-design
41
- npx @cremini/skillpack skills add ./my-local-skills --skill local-helper
45
+ npx @cremini/skillpack run
46
+ npx @cremini/skillpack run ./comic-explainer
47
+ ```
48
+
49
+ - If `skillpack.json` is missing, you are prompted to create one on the spot.
50
+ - Any remote skills declared in the config but not yet installed are installed automatically.
51
+ - The server starts and opens [http://127.0.0.1:26313](http://127.0.0.1:26313) in your browser.
42
52
 
43
- # Manage prompts
44
- npx @cremini/skillpack prompts add "Collect company data using Skill A, create charts from the data using Skill B, and compile the results into a PowerPoint using Skill C"
45
- npx @cremini/skillpack prompts list
53
+ ### Package a pack for distribution
46
54
 
47
- # Package the current app
48
- npx @cremini/skillpack build
55
+ ```bash
56
+ npx @cremini/skillpack zip
49
57
  ```
50
58
 
51
- ## Commands
59
+ Produces `<pack-name>.zip` in the current directory.
60
+
61
+ ---
62
+
63
+ ## Skill Source Formats
64
+
65
+ When adding skills through `create`, the source field accepts:
66
+
67
+ ```bash
68
+ # GitHub shorthand
69
+ vercel-labs/agent-skills --skill frontend-design
52
70
 
53
- | Command | Description |
54
- | ------------------------ | ------------------------------------- |
55
- | `create` | Create a skill pack interactively |
56
- | `init` | Initialize from a config path or URL |
57
- | `skills add <source>` | Add one or more skills with `--skill` |
58
- | `skills remove <name>` | Remove a skill |
59
- | `skills list` | List installed skills |
60
- | `prompts add <text>` | Add a prompt |
61
- | `prompts remove <index>` | Remove a prompt |
62
- | `prompts list` | List all prompts |
63
- | `build` | Package the skill pack as a zip file |
71
+ # Full GitHub URL
72
+ https://github.com/JimLiu/baoyu-skills/tree/main/skills --skill baoyu-comic
73
+
74
+ # Local path
75
+ ./skills/my-local-skill
76
+ ```
77
+
78
+ Multiple skill names from the same source can be listed comma-separated.
79
+
80
+ ---
64
81
 
65
82
  ## Zip Output
66
83
 
67
- The extracted archive looks like this:
84
+ The archive produced by `zip` is intentionally minimal:
68
85
 
69
86
  ```text
70
- skillpack/
87
+ <pack-name>/
71
88
  ├── skillpack.json # Pack configuration
72
- ├── skills/ # Collected SKILL.md files
73
- ├── server/ # Runtime backend
74
- ├── web/ # Runtime web UI
75
- ├── start.sh # One-click launcher for macOS/Linux
76
- ├── start.bat # One-click launcher for Windows
77
- └── README.md # Runtime guide
89
+ ├── skills/ # Installed skills
90
+ ├── start.sh # One-click launcher for macOS / Linux
91
+ └── start.bat # One-click launcher for Windows
78
92
  ```
79
93
 
80
- ### Run the Skill Pack
94
+ The start scripts use `npx @cremini/skillpack run .` so Node.js is the only prerequisite — no pre-bundled server directory is included.
95
+
96
+ ### Run a distributed pack
81
97
 
82
98
  ```bash
83
99
  # macOS / Linux
@@ -87,11 +103,35 @@ skillpack/
87
103
  start.bat
88
104
  ```
89
105
 
90
- Running start.sh will open [http://127.0.0.1:26313](http://127.0.0.1:26313) in your browser. Just enter your API key to get started and enjoy!
106
+ The browser opens [http://127.0.0.1:26313](http://127.0.0.1:26313) automatically. Enter your API key and start working.
107
+
108
+ ---
109
+
110
+ ## IM Integrations
111
+
112
+ The runtime supports **Slack** and **Telegram** in addition to the built-in web UI. Configure them in `data/config.json` (created at runtime, not included in the zip):
113
+
114
+ ```json
115
+ {
116
+ "adapters": {
117
+ "telegram": {
118
+ "token": "123456:ABC-DEF..."
119
+ },
120
+ "slack": {
121
+ "botToken": "xoxb-...",
122
+ "appToken": "xapp-..."
123
+ }
124
+ }
125
+ }
126
+ ```
127
+
128
+ See [docs/runtime/im-adapters.md](docs/runtime/im-adapters.md) for setup requirements.
129
+
130
+ ---
91
131
 
92
132
  ## Development
93
133
 
94
- For development details, see [Development Guide](docs/development.md).
134
+ For build commands, CLI reference, and environment variables, see [Development Guide](docs/development.md).
95
135
 
96
136
  ## License
97
137
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cremini/skillpack",
3
- "version": "1.1.4-beta.0",
3
+ "version": "1.1.4",
4
4
  "description": "Pack AI Skills into Local Agents",
5
5
  "type": "module",
6
6
  "repository": {