Skip to content

Commit 8b56015

Browse files
author
jovanSAPFIONEER
committed
docs: add PowerShell/Windows activation instructions to README
1 parent 9872dd3 commit 8b56015

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,55 @@ npm run setup -- --list # List all 12 available adapters
246246
npm run setup:example # Generate a starter example.ts
247247
```
248248

249+
### Running in PowerShell (Windows)
250+
251+
All commands work in PowerShell. The only difference from bash is how you set environment variables.
252+
253+
**Set your API key for the current session:**
254+
255+
```powershell
256+
$env:OPENAI_API_KEY = "sk-..."
257+
```
258+
259+
**Or load it from `.env` automatically** — copy the template first:
260+
261+
```powershell
262+
Copy-Item .env.example .env # then open .env and fill in your key
263+
```
264+
265+
**Run the examples (no API key needed):**
266+
267+
```powershell
268+
npx ts-node examples/01-hello-swarm.ts
269+
npx ts-node examples/02-fsm-pipeline.ts
270+
npx ts-node examples/03-parallel-agents.ts
271+
```
272+
273+
**Run the interactive launcher** (picks which example to run):
274+
275+
```powershell
276+
npx ts-node run.ts
277+
```
278+
279+
**Run the AI code review swarm demo** (requires `OPENAI_API_KEY`):
280+
281+
```powershell
282+
$env:OPENAI_API_KEY = "sk-..."
283+
npx ts-node examples/05-code-review-swarm.ts
284+
```
285+
286+
**Run the tests:**
287+
288+
```powershell
289+
npm test # Core orchestrator (79 tests)
290+
npm run test:security # Security module (33 tests)
291+
npm run test:adapters # Adapter system (139 tests)
292+
npm run test:priority # Priority & preemption (64 tests)
293+
npm run test:all # All suites in sequence
294+
```
295+
296+
> **Tip:** To persist `OPENAI_API_KEY` across sessions, add it to your PowerShell profile or set it as a user environment variable via *System Properties → Environment Variables*.
297+
249298
### For OpenClaw Users
250299

251300
Copy this skill into your OpenClaw workspace:

0 commit comments

Comments
 (0)