ape-claw 0.1.6 → 0.1.8
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 +157 -8
- package/docs/operator/01-quickstart.md +81 -72
- package/docs/operator/03-cli-reference.md +46 -5
- package/package.json +1 -1
- package/src/cli.mjs +551 -15
- package/src/lib/openclaw-paths.mjs +65 -0
- package/src/server/index.mjs +8 -2
- package/src/server/middleware/auth.mjs +10 -0
- package/src/server/routes/forge-agent.mjs +438 -58
- package/src/server/routes/openclaw-env.mjs +206 -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.
|
|
@@ -800,6 +817,138 @@ The CLI auto-retries "Order not found" errors up to 3 times by fetching fresh li
|
|
|
800
817
|
|
|
801
818
|
---
|
|
802
819
|
|
|
820
|
+
## Troubleshooting
|
|
821
|
+
|
|
822
|
+
### `openclaw: command not found` after install
|
|
823
|
+
|
|
824
|
+
The OpenClaw installer may not update your shell PATH automatically. Fix:
|
|
825
|
+
|
|
826
|
+
```bash
|
|
827
|
+
mkdir -p "$HOME/.npm-global"
|
|
828
|
+
npm config set prefix "$HOME/.npm-global"
|
|
829
|
+
npm install -g openclaw@latest
|
|
830
|
+
export PATH="$HOME/.npm-global/bin:$PATH"
|
|
831
|
+
rehash # zsh only
|
|
832
|
+
```
|
|
833
|
+
|
|
834
|
+
Add the `export PATH` line to `~/.zshrc` (or `~/.bashrc`) to make it permanent.
|
|
835
|
+
|
|
836
|
+
### `Unknown command: dashboard`
|
|
837
|
+
|
|
838
|
+
You are running a stale cached version of `ape-claw`. Force the latest:
|
|
839
|
+
|
|
840
|
+
```bash
|
|
841
|
+
rm -rf ~/.npm/_npx
|
|
842
|
+
npm cache verify
|
|
843
|
+
npx --yes ape-claw@latest dashboard
|
|
844
|
+
```
|
|
845
|
+
|
|
846
|
+
Always use `npx --yes ape-claw@latest` (not just `npx ape-claw`) for fresh installs.
|
|
847
|
+
|
|
848
|
+
### OpenClaw gateway not starting / `openclaw.json` missing
|
|
849
|
+
|
|
850
|
+
If `openclaw gateway start` fails silently after a fresh install, generate the config first:
|
|
851
|
+
|
|
852
|
+
```bash
|
|
853
|
+
openclaw onboard --non-interactive --accept-risk --auth-choice skip --install-daemon --skip-channels --skip-skills --skip-ui --json
|
|
854
|
+
openclaw gateway start
|
|
855
|
+
```
|
|
856
|
+
|
|
857
|
+
The `dashboard` command does this automatically, but running it manually helps if the gateway service is stuck.
|
|
858
|
+
|
|
859
|
+
### `Disconnected from gateway: device token mismatch` or `pairing required`
|
|
860
|
+
|
|
861
|
+
After reinstalling or regenerating OpenClaw config, the CLI may have a stale device token. Approve the pending pairing request:
|
|
862
|
+
|
|
863
|
+
```bash
|
|
864
|
+
# List pending requests
|
|
865
|
+
openclaw devices list
|
|
866
|
+
|
|
867
|
+
# Approve the pending request (copy the Request ID from the Pending table)
|
|
868
|
+
openclaw devices approve <request-id>
|
|
869
|
+
```
|
|
870
|
+
|
|
871
|
+
The `ape-claw dashboard` command auto-detects and approves pending pairings, but if you see this on the native OpenClaw dashboard, approve manually as shown above.
|
|
872
|
+
|
|
873
|
+
### Forge chat returns `Error: internal error`
|
|
874
|
+
|
|
875
|
+
This usually means the OpenClaw gateway cannot reach its configured LLM. Common causes:
|
|
876
|
+
|
|
877
|
+
1. **Wrong model for your API key**: OpenClaw defaults to `anthropic/claude-opus-4-6`. If you only have an OpenAI key:
|
|
878
|
+
```bash
|
|
879
|
+
openclaw config set agents.defaults.model.primary "openai/gpt-4o"
|
|
880
|
+
openclaw gateway restart
|
|
881
|
+
```
|
|
882
|
+
|
|
883
|
+
2. **Invalid API key saved**: Check `~/.openclaw/.env` — the `OPENAI_API_KEY` value should start with `sk-`. If it looks like garbage, re-enter it.
|
|
884
|
+
|
|
885
|
+
3. **Gateway pairing issue**: The Forge backend calls `openclaw agent` which needs a paired device:
|
|
886
|
+
```bash
|
|
887
|
+
openclaw devices pair --auto-approve
|
|
888
|
+
```
|
|
889
|
+
|
|
890
|
+
### Forge page loads but chat says `Forge agent not configured`
|
|
891
|
+
|
|
892
|
+
The Forge reads LLM keys from OpenClaw's config, not its own env. Make sure you have a key in `~/.openclaw/.env`:
|
|
893
|
+
|
|
894
|
+
```bash
|
|
895
|
+
echo 'OPENAI_API_KEY=sk-your-key-here' >> ~/.openclaw/.env
|
|
896
|
+
```
|
|
897
|
+
|
|
898
|
+
Then set the matching model:
|
|
899
|
+
|
|
900
|
+
```bash
|
|
901
|
+
openclaw config set agents.defaults.model.primary "openai/gpt-4o"
|
|
902
|
+
openclaw gateway restart
|
|
903
|
+
```
|
|
904
|
+
|
|
905
|
+
### `localhost:8787` not loading (Forge server)
|
|
906
|
+
|
|
907
|
+
On macOS, `localhost` may resolve to IPv6 (`::1`) while the server binds to IPv4. Use `http://127.0.0.1:8787/forge` instead. The latest version binds to `0.0.0.0` by default, fixing this.
|
|
908
|
+
|
|
909
|
+
### `.zshrc` parse error on shell startup
|
|
910
|
+
|
|
911
|
+
If you see `parse error near 'fi'` or similar, the OpenClaw installer may have left a stale snippet. Edit `~/.zshrc`, remove the broken block, and make the OpenClaw completion line conditional:
|
|
912
|
+
|
|
913
|
+
```bash
|
|
914
|
+
if [ -f "$HOME/.openclaw/completions/openclaw.zsh" ]; then
|
|
915
|
+
source "$HOME/.openclaw/completions/openclaw.zsh"
|
|
916
|
+
fi
|
|
917
|
+
```
|
|
918
|
+
|
|
919
|
+
### Fresh install checklist (zero to working Forge)
|
|
920
|
+
|
|
921
|
+
```bash
|
|
922
|
+
# 1. Install OpenClaw
|
|
923
|
+
curl -fsSL https://openclaw.ai/install.sh | bash
|
|
924
|
+
export PATH="$HOME/.npm-global/bin:$PATH"
|
|
925
|
+
rehash # zsh only
|
|
926
|
+
|
|
927
|
+
# 2. Onboard + start gateway
|
|
928
|
+
openclaw onboard --non-interactive --accept-risk \
|
|
929
|
+
--auth-choice skip --install-daemon \
|
|
930
|
+
--skip-channels --skip-skills --skip-ui --json
|
|
931
|
+
openclaw gateway install
|
|
932
|
+
# Wait a few seconds for the gateway service to start, then approve pairing:
|
|
933
|
+
sleep 5
|
|
934
|
+
openclaw devices list
|
|
935
|
+
# Copy the Request ID from the Pending table, then:
|
|
936
|
+
openclaw devices approve <request-id>
|
|
937
|
+
|
|
938
|
+
# 3. Set your LLM key
|
|
939
|
+
echo 'OPENAI_API_KEY=sk-your-key-here' >> ~/.openclaw/.env
|
|
940
|
+
openclaw config set agents.defaults.model.primary "openai/gpt-4o"
|
|
941
|
+
openclaw gateway restart
|
|
942
|
+
|
|
943
|
+
# 4. Install ApeClaw + open Forge
|
|
944
|
+
npx --yes ape-claw@latest skill install
|
|
945
|
+
npx --yes ape-claw@latest dashboard
|
|
946
|
+
```
|
|
947
|
+
|
|
948
|
+
The `ape-claw dashboard` command automates steps 2-3 when possible (auto-onboard, auto-approve pending devices, auto-set model to match your API key). If something still fails, running the manual steps above resolves it.
|
|
949
|
+
|
|
950
|
+
---
|
|
951
|
+
|
|
803
952
|
## Development
|
|
804
953
|
|
|
805
954
|
```bash
|
|
@@ -13,123 +13,117 @@ Get ApeClaw running and execute your first skill in 5 minutes.
|
|
|
13
13
|
|
|
14
14
|
## Step 1: Install OpenClaw
|
|
15
15
|
|
|
16
|
-
Install [OpenClaw](https://openclaw.ai)
|
|
16
|
+
Install [OpenClaw](https://openclaw.ai):
|
|
17
17
|
|
|
18
18
|
```bash
|
|
19
|
-
openclaw
|
|
19
|
+
curl -fsSL https://openclaw.ai/install.sh | bash
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
## Step 2: Install ApeClaw
|
|
22
|
+
After install, make sure `openclaw` is on your PATH. If `openclaw: command not found`:
|
|
25
23
|
|
|
26
24
|
```bash
|
|
27
|
-
|
|
28
|
-
|
|
25
|
+
export PATH="$HOME/.npm-global/bin:$PATH"
|
|
26
|
+
rehash # zsh only
|
|
29
27
|
```
|
|
30
28
|
|
|
31
|
-
|
|
29
|
+
Add that `export PATH` line to your `~/.zshrc` or `~/.bashrc` for persistence.
|
|
32
30
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
31
|
+
Verify:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
openclaw --version
|
|
36
35
|
```
|
|
37
36
|
|
|
38
|
-
## Step
|
|
37
|
+
## Step 2: Set up the OpenClaw gateway
|
|
38
|
+
|
|
39
|
+
The gateway is the local runtime that powers the AI agent. Generate config and start it:
|
|
39
40
|
|
|
40
41
|
```bash
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
--api https://apeclaw.ai \
|
|
45
|
-
--json
|
|
42
|
+
openclaw onboard --non-interactive --accept-risk --auth-choice skip --install-daemon --skip-channels --skip-skills --skip-ui --json
|
|
43
|
+
openclaw gateway start
|
|
44
|
+
openclaw devices pair --auto-approve
|
|
46
45
|
```
|
|
47
46
|
|
|
48
|
-
|
|
47
|
+
## Step 3: Configure your LLM provider
|
|
49
48
|
|
|
50
|
-
|
|
49
|
+
Set your API key. Pick one provider:
|
|
51
50
|
|
|
52
51
|
```bash
|
|
53
|
-
|
|
54
|
-
|
|
52
|
+
# OpenAI (recommended)
|
|
53
|
+
echo 'OPENAI_API_KEY=sk-your-key-here' >> ~/.openclaw/.env
|
|
54
|
+
openclaw config set agents.defaults.model.primary "openai/gpt-4o"
|
|
55
|
+
|
|
56
|
+
# Or Anthropic
|
|
57
|
+
# echo 'ANTHROPIC_API_KEY=sk-ant-your-key-here' >> ~/.openclaw/.env
|
|
55
58
|
```
|
|
56
59
|
|
|
57
|
-
|
|
60
|
+
Restart the gateway to pick up the new config:
|
|
58
61
|
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
$env:APE_CLAW_AGENT_TOKEN="claw_..."
|
|
62
|
+
```bash
|
|
63
|
+
openclaw gateway restart
|
|
62
64
|
```
|
|
63
65
|
|
|
64
|
-
|
|
66
|
+
You can also set keys later via the Forge settings button (top-right gear icon).
|
|
65
67
|
|
|
66
|
-
|
|
68
|
+
## Step 4: Install ApeClaw
|
|
67
69
|
|
|
68
|
-
|
|
70
|
+
```bash
|
|
71
|
+
npx --yes ape-claw@latest skill install
|
|
72
|
+
npx --yes ape-claw@latest doctor --json
|
|
73
|
+
```
|
|
69
74
|
|
|
70
|
-
|
|
75
|
+
During `skill install`, ApeClaw prompts for:
|
|
76
|
+
- **Starter pack** — 61 curated skills across productivity, dev tools, security, analytics, SEO, and automation
|
|
77
|
+
- **Forge dashboard upgrade** — replaces the local OpenClaw dashboard with the enhanced Forge UI
|
|
71
78
|
|
|
72
|
-
|
|
79
|
+
PowerShell (Windows):
|
|
73
80
|
|
|
74
|
-
|
|
81
|
+
```powershell
|
|
82
|
+
npx --yes ape-claw@latest skill install
|
|
83
|
+
npx --yes ape-claw@latest doctor --json
|
|
84
|
+
```
|
|
75
85
|
|
|
76
|
-
|
|
86
|
+
## Step 5: Open the Forge Dashboard
|
|
77
87
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
- **Perplexity** (`PERPLEXITY_API_KEY`) — Sonar (web-grounded)
|
|
82
|
-
- **Groq** (`GROQ_API_KEY`) — fast Llama inference (free tier available)
|
|
83
|
-
- **Together AI** (`TOGETHER_API_KEY`) — open-source models
|
|
84
|
-
- **Ollama** (`OLLAMA_HOST`) — run models locally, no API key needed
|
|
85
|
-
- **Any OpenAI-compatible endpoint** (`FORGE_LLM_API_URL` + `FORGE_LLM_API_KEY`)
|
|
86
|
-
2. **OpenClaw + ape-claw skills** installed (you already have these from Step 1-2).
|
|
88
|
+
```bash
|
|
89
|
+
npx --yes ape-claw@latest dashboard
|
|
90
|
+
```
|
|
87
91
|
|
|
88
|
-
|
|
92
|
+
This starts the local Forge server and opens `http://localhost:8787/forge` in your browser. Chat with your agent, manage skills, and control the gateway — all from one place.
|
|
89
93
|
|
|
90
|
-
|
|
94
|
+
To restore the original OpenClaw dashboard files:
|
|
91
95
|
|
|
92
96
|
```bash
|
|
93
|
-
|
|
94
|
-
export OPENAI_API_KEY=sk-...
|
|
95
|
-
export ANTHROPIC_API_KEY=sk-ant-...
|
|
96
|
-
export PERPLEXITY_API_KEY=pplx-...
|
|
97
|
-
export GROQ_API_KEY=gsk_...
|
|
98
|
-
export OLLAMA_HOST=http://localhost:11434
|
|
97
|
+
npx ape-claw dashboard restore-openclaw
|
|
99
98
|
```
|
|
100
99
|
|
|
101
|
-
|
|
100
|
+
## Step 6: Register a Clawbot (optional)
|
|
102
101
|
|
|
103
|
-
|
|
102
|
+
Registration enables telemetry and the global dashboard. It is not required for local Forge usage.
|
|
104
103
|
|
|
105
104
|
```bash
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
105
|
+
npx ape-claw clawbot register \
|
|
106
|
+
--agent-id my-bot \
|
|
107
|
+
--name "My Bot" \
|
|
108
|
+
--api https://apeclaw.ai \
|
|
109
|
+
--json
|
|
109
110
|
```
|
|
110
111
|
|
|
111
|
-
|
|
112
|
+
Save the `claw_...` token — it's shown only once.
|
|
112
113
|
|
|
113
114
|
```bash
|
|
114
|
-
|
|
115
|
+
export APE_CLAW_AGENT_ID=my-bot
|
|
116
|
+
export APE_CLAW_AGENT_TOKEN=claw_...
|
|
115
117
|
```
|
|
116
118
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
### How it works
|
|
119
|
+
## Step 7: Browse Skills
|
|
120
120
|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
1. Loads your installed OpenClaw skills from `~/.openclaw/skills/` (re-scans every 5 minutes).
|
|
124
|
-
2. Fetches a live telemetry snapshot — recent events, chat messages, clawbots, skill stats, pod status, and spend data.
|
|
125
|
-
3. Builds a system prompt with your agent identity, skill knowledge, and telemetry context.
|
|
126
|
-
4. Streams the response from your configured LLM provider back to the browser via SSE.
|
|
127
|
-
5. Logs the conversation to the chat log and emits a telemetry event.
|
|
121
|
+
Visit [/skills](https://apeclaw.ai/skills) to browse 10,000+ skills in the library, with 10,000+ minted onchain, served via API.
|
|
128
122
|
|
|
129
|
-
|
|
123
|
+
## Step 8: Verify Forge is working
|
|
130
124
|
|
|
131
125
|
```bash
|
|
132
|
-
curl -s http://
|
|
126
|
+
curl -s http://127.0.0.1:8787/api/forge/status | jq .
|
|
133
127
|
```
|
|
134
128
|
|
|
135
129
|
Expected output:
|
|
@@ -137,15 +131,30 @@ Expected output:
|
|
|
137
131
|
```json
|
|
138
132
|
{
|
|
139
133
|
"configured": true,
|
|
134
|
+
"provider": "openclaw-gateway",
|
|
140
135
|
"agentId": "the-clawllector",
|
|
141
136
|
"agentName": "The Clawllector",
|
|
142
|
-
"
|
|
143
|
-
"
|
|
144
|
-
"
|
|
137
|
+
"gatewayReady": true,
|
|
138
|
+
"llmProviderHint": "openai",
|
|
139
|
+
"llmModelHint": "gpt-4o",
|
|
140
|
+
"skills": 61
|
|
145
141
|
}
|
|
146
142
|
```
|
|
147
143
|
|
|
148
|
-
If `"configured": false`, your
|
|
144
|
+
If `"configured": false`, your OpenClaw gateway LLM provider is not set up yet. Go to the Forge settings (gear icon) and add your API key, or follow Step 3 above.
|
|
145
|
+
|
|
146
|
+
## Troubleshooting
|
|
147
|
+
|
|
148
|
+
| Symptom | Fix |
|
|
149
|
+
|---------|-----|
|
|
150
|
+
| `openclaw: command not found` | `export PATH="$HOME/.npm-global/bin:$PATH"` then `rehash` |
|
|
151
|
+
| `Unknown command: dashboard` | `rm -rf ~/.npm/_npx && npm cache verify`, then re-run with `npx --yes ape-claw@latest` |
|
|
152
|
+
| `device token mismatch` on dashboard | `openclaw devices list`, then `openclaw devices approve <request-id>` |
|
|
153
|
+
| `Error: internal error` in chat | Check model matches key: `openclaw config set agents.defaults.model.primary "openai/gpt-4o"` then `openclaw gateway restart` |
|
|
154
|
+
| Forge not loading on `localhost:8787` | Try `http://127.0.0.1:8787/forge` instead (macOS IPv6 issue) |
|
|
155
|
+
| Gateway won't start | Run `openclaw onboard --non-interactive --accept-risk --auth-choice skip --install-daemon --skip-channels --skip-skills --skip-ui --json` first |
|
|
156
|
+
|
|
157
|
+
See the main [README Troubleshooting section](../../README.md#troubleshooting) for detailed guidance.
|
|
149
158
|
|
|
150
159
|
## Next Steps
|
|
151
160
|
|
|
@@ -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,36 @@ 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
|
+
**What it does automatically:**
|
|
109
|
+
- Generates `~/.openclaw/openclaw.json` via `openclaw onboard` if missing
|
|
110
|
+
- Starts the OpenClaw gateway if not running
|
|
111
|
+
- Auto-pairs the local device if token mismatch is detected
|
|
112
|
+
- Sets gateway model to `openai/gpt-4o` if `OPENAI_API_KEY` is present but model points at Anthropic
|
|
113
|
+
- Starts the local Forge server and opens the browser
|
|
114
|
+
|
|
115
|
+
**Output:** Returns/prints dashboard URL, server startup status, browser open result, and overwrite/reapply status when applicable.
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
79
119
|
#### `chain info`
|
|
80
120
|
|
|
81
121
|
Get chain information including latest block.
|
|
@@ -520,7 +560,7 @@ Install skills for Cursor/OpenClaw. Without a slug, installs the core `ape-claw`
|
|
|
520
560
|
|
|
521
561
|
**Synopsis:**
|
|
522
562
|
```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
|
|
563
|
+
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
564
|
```
|
|
525
565
|
|
|
526
566
|
**Required arguments:** None
|
|
@@ -530,6 +570,7 @@ ape-claw skill install [<slug>] [--scope <local|global>] [--skills-dir <path>] [
|
|
|
530
570
|
- `--scope <local|global>` — Installation scope (default: `global` → `~/.openclaw/skills/`; `local` installs into the current project)
|
|
531
571
|
- `--skills-dir <path>` — Explicit skills directory path
|
|
532
572
|
- `--starter-pack` / `--no-starter-pack` — Install or skip the curated starter pack when running without a slug
|
|
573
|
+
- `--forge-upgrade` / `--no-forge-upgrade` — Opt in/out of Forge dashboard upgrade during core install (without a slug)
|
|
533
574
|
- `--allow-unvetted` — Permit API-fetched skills that are not marked vetted
|
|
534
575
|
- `--allow-high-risk` — Permit API-fetched skills with risk tier 3
|
|
535
576
|
- `--allow-custom-api` — Permit non-apeclaw.ai API hosts (advanced/dev use only)
|