ape-claw 0.1.6 → 0.1.7
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 +25 -8
- package/docs/operator/01-quickstart.md +28 -10
- package/docs/operator/03-cli-reference.md +39 -5
- package/package.json +1 -1
- package/src/cli.mjs +500 -15
- package/src/lib/openclaw-paths.mjs +65 -0
- package/src/server/index.mjs +7 -1
- package/src/server/middleware/auth.mjs +10 -0
- package/src/server/routes/forge-agent.mjs +362 -58
- package/src/server/routes/openclaw-env.mjs +181 -0
- package/src/server/routes/skills.mjs +80 -3
- package/ui/forge/css/forge.css +153 -2
- package/ui/forge/index.html +40 -6
- package/ui/forge/js/forge-attachments.js +616 -377
- package/ui/forge/js/forge-chat.js +201 -90
- package/ui/forge/js/forge-data.js +305 -11
- package/ui/forge/js/forge-scene.js +178 -18
- package/ui/index.html +3 -3
package/README.md
CHANGED
|
@@ -188,11 +188,12 @@ export APECLAW_SKILLCARD_URI_BASE="https://example.com/skillcards/seed"
|
|
|
188
188
|
### One-command install (no repo clone)
|
|
189
189
|
|
|
190
190
|
```bash
|
|
191
|
-
npx ape-claw skill install
|
|
191
|
+
npx --yes ape-claw@latest skill install
|
|
192
192
|
```
|
|
193
193
|
|
|
194
194
|
Installs the ApeClaw skill into `~/.openclaw/skills/ape-claw/` and bootstraps config files.
|
|
195
195
|
Requires OpenClaw and Node.js `>=22.10.0`. Works on macOS, Linux, and Windows.
|
|
196
|
+
During install, ApeClaw also prompts to enable the local Forge dashboard upgrade path.
|
|
196
197
|
|
|
197
198
|
### Fast path for new users (copy/paste)
|
|
198
199
|
|
|
@@ -201,8 +202,11 @@ Requires OpenClaw and Node.js `>=22.10.0`. Works on macOS, Linux, and Windows.
|
|
|
201
202
|
# Verify it's available:
|
|
202
203
|
openclaw skills list
|
|
203
204
|
|
|
204
|
-
# 1) Install ApeClaw
|
|
205
|
-
npx ape-claw skill install
|
|
205
|
+
# 1) Install ApeClaw (force latest npm release)
|
|
206
|
+
npx --yes ape-claw@latest skill install
|
|
207
|
+
|
|
208
|
+
# 1b) Open local Forge dashboard (starts local server if needed)
|
|
209
|
+
npx --yes ape-claw@latest dashboard
|
|
206
210
|
|
|
207
211
|
# 2) Verify (always works, even if global PATH is not set yet)
|
|
208
212
|
npx ape-claw doctor --json
|
|
@@ -258,21 +262,25 @@ After the core install, you'll be prompted to install the **Starter Pack** (61 s
|
|
|
258
262
|
|
|
259
263
|
```bash
|
|
260
264
|
# Interactive: prompts you to choose
|
|
261
|
-
npx ape-claw skill install
|
|
265
|
+
npx --yes ape-claw@latest skill install
|
|
262
266
|
|
|
263
267
|
# Auto-install starter pack (no prompt)
|
|
264
|
-
npx ape-claw skill install --starter-pack
|
|
268
|
+
npx --yes ape-claw@latest skill install --starter-pack
|
|
265
269
|
|
|
266
270
|
# Skip starter pack entirely
|
|
267
|
-
npx ape-claw skill install --no-starter-pack
|
|
271
|
+
npx --yes ape-claw@latest skill install --no-starter-pack
|
|
268
272
|
|
|
269
273
|
# JSON mode (programmatic): skips prompt, add --starter-pack to include it
|
|
270
|
-
npx ape-claw skill install --starter-pack --json
|
|
274
|
+
npx --yes ape-claw@latest skill install --starter-pack --json
|
|
271
275
|
|
|
272
276
|
# Install into current project only (instead of global ~/.openclaw/)
|
|
273
|
-
npx ape-claw skill install --scope local
|
|
277
|
+
npx --yes ape-claw@latest skill install --scope local
|
|
274
278
|
```
|
|
275
279
|
|
|
280
|
+
The same install flow also prompts for the local Forge dashboard upgrade.
|
|
281
|
+
Use `npx --yes ape-claw@latest dashboard` anytime as the stable local Forge entrypoint.
|
|
282
|
+
If you see `Unknown command: dashboard`, you are running an older cached package — re-run with `npx --yes ape-claw@latest ...`.
|
|
283
|
+
|
|
276
284
|
### 3. Global CLI install (optional)
|
|
277
285
|
|
|
278
286
|
```bash
|
|
@@ -556,6 +564,15 @@ Then open `http://localhost:8787/` for the real-time dashboard showing:
|
|
|
556
564
|
- Bridge operation status
|
|
557
565
|
- Connection health
|
|
558
566
|
|
|
567
|
+
For local Forge/OpenClaw takeover dashboard (no repo clone required), run:
|
|
568
|
+
|
|
569
|
+
```bash
|
|
570
|
+
npx ape-claw dashboard
|
|
571
|
+
```
|
|
572
|
+
|
|
573
|
+
This starts the packaged local UI server from npm and opens Forge.
|
|
574
|
+
GitHub clone + `npm run start:ui` is optional for development workflows.
|
|
575
|
+
|
|
559
576
|
### Clawllector Chat API
|
|
560
577
|
|
|
561
578
|
Verified clawbots can chat with each other through the telemetry server.
|
|
@@ -24,15 +24,21 @@ If `openclaw` is not found, follow the setup guide at [openclaw.ai](https://open
|
|
|
24
24
|
## Step 2: Install ApeClaw
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
|
-
npx ape-claw skill install
|
|
28
|
-
npx ape-claw doctor --json
|
|
27
|
+
npx --yes ape-claw@latest skill install
|
|
28
|
+
npx --yes ape-claw@latest doctor --json
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
+
During `skill install`, ApeClaw prompts for:
|
|
32
|
+
- Starter pack install
|
|
33
|
+
- Forge dashboard upgrade (replaces the local OpenClaw dashboard route when supported, with automatic fallback)
|
|
34
|
+
|
|
35
|
+
> Note: OpenClaw dashboard overwrite is best-effort and temporary. OpenClaw updates may restore the original dashboard files. Use `npx ape-claw dashboard` as the stable entrypoint.
|
|
36
|
+
|
|
31
37
|
PowerShell (Windows):
|
|
32
38
|
|
|
33
39
|
```powershell
|
|
34
|
-
npx ape-claw skill install
|
|
35
|
-
npx ape-claw doctor --json
|
|
40
|
+
npx --yes ape-claw@latest skill install
|
|
41
|
+
npx --yes ape-claw@latest doctor --json
|
|
36
42
|
```
|
|
37
43
|
|
|
38
44
|
## Step 3: Register a Clawbot
|
|
@@ -63,7 +69,20 @@ $env:APE_CLAW_AGENT_TOKEN="claw_..."
|
|
|
63
69
|
|
|
64
70
|
## Step 5: Open the Dashboard
|
|
65
71
|
|
|
66
|
-
|
|
72
|
+
Use:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
npx --yes ape-claw@latest dashboard
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
This opens your local Forge dashboard (`http://localhost:8787/forge`) and starts the local server if needed.
|
|
79
|
+
If OpenClaw is not installed yet, the command prints install steps first.
|
|
80
|
+
|
|
81
|
+
To restore the original OpenClaw dashboard files:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
npx ape-claw dashboard restore-openclaw
|
|
85
|
+
```
|
|
67
86
|
|
|
68
87
|
## Step 6: Browse Skills
|
|
69
88
|
|
|
@@ -75,14 +94,14 @@ The Forge page at `/forge` includes an AI chat panel. On the live website (apecl
|
|
|
75
94
|
|
|
76
95
|
### What you need
|
|
77
96
|
|
|
78
|
-
1. **
|
|
97
|
+
1. **An OpenClaw Gateway LLM provider configured** — Forge inherits provider/model from your active OpenClaw profile.
|
|
98
|
+
You can configure this in OpenClaw or from Forge Settings (OpenClaw `.env` editor). Common keys:
|
|
79
99
|
- **OpenAI** (`OPENAI_API_KEY`) — GPT-4o, GPT-4, etc.
|
|
80
100
|
- **Anthropic** (`ANTHROPIC_API_KEY`) — Claude models
|
|
81
101
|
- **Perplexity** (`PERPLEXITY_API_KEY`) — Sonar (web-grounded)
|
|
82
102
|
- **Groq** (`GROQ_API_KEY`) — fast Llama inference (free tier available)
|
|
83
103
|
- **Together AI** (`TOGETHER_API_KEY`) — open-source models
|
|
84
104
|
- **Ollama** (`OLLAMA_HOST`) — run models locally, no API key needed
|
|
85
|
-
- **Any OpenAI-compatible endpoint** (`FORGE_LLM_API_URL` + `FORGE_LLM_API_KEY`)
|
|
86
105
|
2. **OpenClaw + ape-claw skills** installed (you already have these from Step 1-2).
|
|
87
106
|
|
|
88
107
|
### Set environment variables
|
|
@@ -105,7 +124,6 @@ Optional overrides:
|
|
|
105
124
|
```bash
|
|
106
125
|
export FORGE_AGENT_NAME="My Agent" # Display name in chat (default: "The Clawllector")
|
|
107
126
|
export FORGE_AGENT_ID=my-agent # ClawBot ID (default: "the-clawllector")
|
|
108
|
-
export FORGE_LLM_MODEL=gpt-4o-mini # Override model (default: auto per provider)
|
|
109
127
|
```
|
|
110
128
|
|
|
111
129
|
### Start the server
|
|
@@ -114,7 +132,7 @@ export FORGE_LLM_MODEL=gpt-4o-mini # Override model (default: auto per prov
|
|
|
114
132
|
npm run start:ui
|
|
115
133
|
```
|
|
116
134
|
|
|
117
|
-
Open [http://localhost:8787/forge](http://localhost:8787/forge). The chat panel
|
|
135
|
+
Open [http://localhost:8787/forge](http://localhost:8787/forge). The chat panel shows an indicator when connected to your OpenClaw gateway session. If no LLM provider is configured, Forge shows a setup hint and keeps chat on the gateway path (`/api/forge/chat`) until provider setup is completed.
|
|
118
136
|
|
|
119
137
|
### How it works
|
|
120
138
|
|
|
@@ -145,7 +163,7 @@ Expected output:
|
|
|
145
163
|
}
|
|
146
164
|
```
|
|
147
165
|
|
|
148
|
-
If `"configured": false`, your
|
|
166
|
+
If `"configured": false`, your OpenClaw gateway provider is not configured yet.
|
|
149
167
|
|
|
150
168
|
## Next Steps
|
|
151
169
|
|
|
@@ -9,15 +9,25 @@ Complete reference for all `ape-claw` CLI commands.
|
|
|
9
9
|
## Installation
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
npx ape-claw skill install
|
|
13
|
-
npx ape-claw doctor --json
|
|
12
|
+
npx --yes ape-claw@latest skill install
|
|
13
|
+
npx --yes ape-claw@latest doctor --json
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
During core install (no slug), ApeClaw prompts for:
|
|
17
|
+
- Starter pack install
|
|
18
|
+
- Forge dashboard upgrade (best-effort OpenClaw local dashboard replacement with safe fallback)
|
|
19
|
+
|
|
20
|
+
Open local Forge anytime with:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx --yes ape-claw@latest dashboard
|
|
14
24
|
```
|
|
15
25
|
|
|
16
26
|
PowerShell (Windows):
|
|
17
27
|
|
|
18
28
|
```powershell
|
|
19
|
-
npx ape-claw skill install
|
|
20
|
-
npx ape-claw doctor --json
|
|
29
|
+
npx --yes ape-claw@latest skill install
|
|
30
|
+
npx --yes ape-claw@latest doctor --json
|
|
21
31
|
```
|
|
22
32
|
|
|
23
33
|
## Global Flags
|
|
@@ -76,6 +86,29 @@ ape-claw quickstart --json
|
|
|
76
86
|
|
|
77
87
|
---
|
|
78
88
|
|
|
89
|
+
#### `dashboard`
|
|
90
|
+
|
|
91
|
+
Open the local ApeClaw Forge dashboard. Starts the local ApeClaw UI server if needed, then opens `http://localhost:8787/forge`.
|
|
92
|
+
|
|
93
|
+
**Synopsis:**
|
|
94
|
+
```bash
|
|
95
|
+
ape-claw dashboard
|
|
96
|
+
ape-claw dashboard --json
|
|
97
|
+
ape-claw dashboard restore-openclaw
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Required arguments:** None
|
|
101
|
+
|
|
102
|
+
**Optional arguments:**
|
|
103
|
+
- `--json` — Return startup/open status details as JSON
|
|
104
|
+
|
|
105
|
+
**Subcommands:**
|
|
106
|
+
- `restore-openclaw` — Restore OpenClaw dashboard UI from `.apeclaw.bak` if present
|
|
107
|
+
|
|
108
|
+
**Output:** Returns/prints dashboard URL, server startup status, browser open result, and overwrite/reapply status when applicable.
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
79
112
|
#### `chain info`
|
|
80
113
|
|
|
81
114
|
Get chain information including latest block.
|
|
@@ -520,7 +553,7 @@ Install skills for Cursor/OpenClaw. Without a slug, installs the core `ape-claw`
|
|
|
520
553
|
|
|
521
554
|
**Synopsis:**
|
|
522
555
|
```bash
|
|
523
|
-
ape-claw skill install [<slug>] [--scope <local|global>] [--skills-dir <path>] [--starter-pack | --no-starter-pack] [--allow-unvetted] [--allow-high-risk] [--allow-custom-api] [--allow-insecure-api] --json
|
|
556
|
+
ape-claw skill install [<slug>] [--scope <local|global>] [--skills-dir <path>] [--starter-pack | --no-starter-pack] [--forge-upgrade | --no-forge-upgrade] [--allow-unvetted] [--allow-high-risk] [--allow-custom-api] [--allow-insecure-api] --json
|
|
524
557
|
```
|
|
525
558
|
|
|
526
559
|
**Required arguments:** None
|
|
@@ -530,6 +563,7 @@ ape-claw skill install [<slug>] [--scope <local|global>] [--skills-dir <path>] [
|
|
|
530
563
|
- `--scope <local|global>` — Installation scope (default: `global` → `~/.openclaw/skills/`; `local` installs into the current project)
|
|
531
564
|
- `--skills-dir <path>` — Explicit skills directory path
|
|
532
565
|
- `--starter-pack` / `--no-starter-pack` — Install or skip the curated starter pack when running without a slug
|
|
566
|
+
- `--forge-upgrade` / `--no-forge-upgrade` — Opt in/out of Forge dashboard upgrade during core install (without a slug)
|
|
533
567
|
- `--allow-unvetted` — Permit API-fetched skills that are not marked vetted
|
|
534
568
|
- `--allow-high-risk` — Permit API-fetched skills with risk tier 3
|
|
535
569
|
- `--allow-custom-api` — Permit non-apeclaw.ai API hosts (advanced/dev use only)
|