@intrect/openswarm 0.8.1 → 0.8.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/README.md +15 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@intrect/openswarm)
|
|
4
4
|
[](https://www.npmjs.com/package/@intrect/openswarm)
|
|
5
|
-
[](LICENSE)
|
|
6
6
|
[](benchmarks/RUBRIC.md)
|
|
7
7
|
[](https://github.com/unohee/OpenSwarm/discussions)
|
|
8
8
|
|
|
@@ -116,26 +116,22 @@ For autonomous operation (Linear issue processing, Discord control, PR auto-impr
|
|
|
116
116
|
|
|
117
117
|
### Configuration
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
After the global install, run the wizard **in the directory you want the daemon to manage** — it writes everything for you:
|
|
120
120
|
|
|
121
121
|
```bash
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
npm install
|
|
125
|
-
cp config.example.yaml config.yaml
|
|
122
|
+
openswarm init # writes config.yaml + .env (provider, task backend, notifications)
|
|
123
|
+
openswarm doctor # verify providers, native deps, ports
|
|
126
124
|
```
|
|
127
125
|
|
|
128
|
-
|
|
126
|
+
See [What `openswarm init` sets up](#what-openswarm-init-sets-up) for the prompts. Prefer to edit by hand? `config.yaml` supports `${VAR}` / `${VAR:-default}` substitution (resolved from `.env`) and is validated with Zod. A minimal `.env` (the wizard writes only what your choices need):
|
|
129
127
|
|
|
130
128
|
```bash
|
|
131
|
-
|
|
132
|
-
DISCORD_CHANNEL_ID=your-channel-id
|
|
133
|
-
LINEAR_API_KEY=your-linear-api-key
|
|
129
|
+
LINEAR_API_KEY=your-linear-api-key # or: openswarm auth login --provider linear
|
|
134
130
|
LINEAR_TEAM_ID=your-linear-team-id
|
|
131
|
+
DISCORD_TOKEN=your-discord-bot-token # only if you chose the discord notifier
|
|
132
|
+
DISCORD_CHANNEL_ID=your-channel-id
|
|
135
133
|
```
|
|
136
134
|
|
|
137
|
-
`config.yaml` supports `${VAR}` / `${VAR:-default}` substitution and is validated with Zod schemas.
|
|
138
|
-
|
|
139
135
|
### Key configuration sections
|
|
140
136
|
|
|
141
137
|
| Section | Description |
|
|
@@ -204,26 +200,17 @@ autonomous:
|
|
|
204
200
|
|
|
205
201
|
### Running the daemon
|
|
206
202
|
|
|
207
|
-
|
|
203
|
+
With the global install, the `openswarm` CLI manages the daemon directly — no repo or `npm run` scripts needed:
|
|
208
204
|
|
|
209
205
|
```bash
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
npm run service:logs # stdout (follow mode)
|
|
216
|
-
npm run service:errors # stderr (follow mode)
|
|
217
|
-
npm run service:uninstall # Uninstall
|
|
206
|
+
openswarm start # start the daemon in the background
|
|
207
|
+
openswarm start --foreground # run attached (logs stream to the terminal)
|
|
208
|
+
openswarm status # pid, uptime, log path
|
|
209
|
+
openswarm stop # stop the daemon
|
|
210
|
+
openswarm dash # open the web dashboard (:3847)
|
|
218
211
|
```
|
|
219
212
|
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
```bash
|
|
223
|
-
npm run build && npm start # Production
|
|
224
|
-
npm run dev # Development (tsx watch)
|
|
225
|
-
docker compose up -d # Docker
|
|
226
|
-
```
|
|
213
|
+
> **From source / development** (contributors): clone the repo and use the `npm run …` scripts (`npm run dev`, `npm start`, `npm run service:install` for a macOS launchd service, `docker compose up -d`). See [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
227
214
|
|
|
228
215
|
---
|
|
229
216
|
|