@cremini/skillpack 1.2.3 → 1.2.5-beta.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/README.md CHANGED
@@ -23,7 +23,7 @@ Skillpack is built for teams that want AI Agents to be deployable, trusted, and
23
23
  1. Download the example
24
24
  - [Garry Tan SkillPack](https://github.com/CreminiAI/skillpack-examples/releases/download/v.0.0.3/garry-tan.zip)
25
25
  - [Company Deep Research SkillPack](https://github.com/FinpeakInc/downloads/releases/download/v.0.0.1/Company-Deep-Research.zip)
26
- 2. Unzip it and Run ./start.sh on Mac OS, and double click start.bat on Windows (see below), the server starts and opens http://127.0.0.1:26313 in your browser
26
+ 2. Unzip it and Run ./start.sh on Mac OS, Or double click start.bat on Windows (see below), the server starts and opens http://127.0.0.1:26313 in your browser
27
27
 
28
28
  ```bash
29
29
  # macOS / Linux
@@ -110,76 +110,14 @@ If present, `AGENTS.md` and `SOUL.md` are read by SkillPack itself when a new ch
110
110
 
111
111
  ## Slack/Telegram Integrations
112
112
 
113
- **Slack Configuration**: requires Slack `App Token` and `Bot Token`<br>
114
- **Telegram configuration**: requires `Bot Token`
113
+ Talk to your Agents on Slack and Telegram
115
114
 
116
- ### Slack App Setup and how to get `App Token` and `Bot Token`
115
+ ### 5 mins to get Slack `App Token` and `Bot Token`
117
116
  https://skillpack.gitbook.io/skillpack-docs/getting-started/slack-integration
118
117
 
119
- 1. Create a new Slack app at https://api.slack.com/apps
120
- 2. Enable Socket Mode (Settings → Socket Mode → Enable)
121
- 3. Generate an App-Level Token with `connections:write` scope. This is **`App Token`**
122
- 4. Add Bot Token Scopes (OAuth & Permissions):
123
-
124
- - `app_mentions:read`
125
- - `channels:history`
126
- - `channels:read`
127
- - `chat:write`
128
- - `files:read`
129
- - `files:write`
130
- - `groups:history`
131
- - `groups:read`
132
- - `im:history`
133
- - `im:read`
134
- - `im:write`
135
- - `users:read`
136
-
137
- 5. Subscribe to Bot Events (Event Subscriptions):
138
-
139
- - `app_mention`
140
- - `message.channels`
141
- - `message.groups`
142
- - `message.im`
143
-
144
- 6. Enable Direct Messages (App Home):
145
- Go to App Home in the left sidebar
146
- Under Show Tabs, enable the Messages Tab
147
- Check Allow users to send Slash commands and messages from the messages tab
148
-
149
- 7. Install the app to your workspace. Get the Bot User OAuth Token. This is **`Bot Token`**
150
- 8. Add the app to any channels where you want the agent to operate (it'll only see messages in channels it's added to)
151
- 9. On the SkillPack buit-in UI http://127.0.0.1:26313, Tap "Connect to Chat App" button and Enter the **`Bot Token`** and **`App Token`**, Save
152
-
153
- ### Telegram Setup and how to get `Bot Token`
118
+ ### 1 min to get Telegram `Bot Token`
154
119
  https://skillpack.gitbook.io/skillpack-docs/getting-started/telegram-integration
155
120
 
156
- 1. **Open Telegram** and search for the official account **`@BotFather`** (it will have a blue verified checkmark).
157
- 2. **Start a chat** by tapping "Start" or sending the `/start` command.
158
- 3. **Send the command** `/newbot` to the BotFather.
159
- 4. **Follow the prompts** to choose a display name and a unique username for your bot. The username must end with the word "bot" (e.g., `MyHelperBot` or `My_Helper_bot`).
160
- 5. **Receive the token**. Once the bot is successfully created, the BotFather will provide you with a message containing your unique API token.
161
- The token will look like a long string of numbers and letters, formatted as `123456789:AABBCCddEeff.... `
162
- 6. On the SkillPack buit-in UI http://127.0.0.1:26313, Tap "Connect to Chat App" button and Enter the **`Bot Token`**, Save
163
-
164
- ### (Optional) Put tokens into data/config.json if you don't use Web UI
165
-
166
- Or Once you have telegram or slack tokens, you can also configure them in `data/config.json` (created at runtime, not included in the zip):
167
- The runtime supports **Slack** and **Telegram** in addition to the built-in web UI.
168
-
169
- ```json
170
- {
171
- "adapters": {
172
- "telegram": {
173
- "token": "123456:ABC-DEF..."
174
- },
175
- "slack": {
176
- "botToken": "xoxb-...",
177
- "appToken": "xapp-..."
178
- }
179
- }
180
- }
181
- ```
182
-
183
121
  ---
184
122
 
185
123
  ## Example Use Cases