ape-claw 0.1.4 → 0.1.5
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 +36 -24
- package/docs/CLI_GUIDE.md +5 -0
- package/docs/GLOBAL_BACKEND.md +3 -1
- package/docs/PRODUCT_OVERVIEW.md +15 -1
- package/docs/STARTER_PACK.md +7 -5
- package/docs/SUPPORTED_NETWORKS.md +1 -1
- package/docs/operator/01-quickstart.md +100 -9
- package/docs/operator/02-dashboard.md +1 -1
- package/docs/operator/03-cli-reference.md +19 -7
- package/docs/operator/04-skills-library.md +13 -12
- package/docs/operator/06-deployment.md +60 -7
- package/docs/operator/09-env-reference.md +61 -0
- package/docs/social/STARTER_PACK_THREAD.md +3 -3
- package/package.json +1 -1
- package/src/cli.mjs +122 -14
- package/src/server/index.mjs +6 -2
- package/src/server/routes/forge-agent.mjs +820 -0
- package/src/server/routes/skills.mjs +39 -6
- package/src/server/storage/file-backend.mjs +31 -0
- package/src/telemetry-server.mjs +90 -4
- package/ui/forge/css/forge.css +30 -2
- package/ui/forge/index.html +20 -7
- package/ui/forge/js/forge-attachments.js +26 -38
- package/ui/forge/js/forge-chat.js +240 -20
- package/ui/forge/js/forge-data.js +76 -14
- package/ui/forge/js/forge-scene.js +1943 -391
- package/ui/index.html +53 -54
- package/ui/js/skills.js +57 -42
- package/ui/shared/sidebar-nav.js +1 -1
- package/ui/skills.html +80 -53
package/README.md
CHANGED
|
@@ -33,6 +33,7 @@ Discover collections, get live listings, quote, simulate, buy NFTs, and bridge f
|
|
|
33
33
|
- **Clawbot verification**: register agents, share API keys, track actions by ID
|
|
34
34
|
- **Structured JSON output**: every command returns machine-parseable JSON
|
|
35
35
|
- **Real-time dashboard**: live telemetry via Server-Sent Events
|
|
36
|
+
- **The Forge**: 3D agent visualizer with live AI chat — talk to The Clawllector (hosted OpenClaw agent) at [apeclaw.ai/forge](https://apeclaw.ai/forge)
|
|
36
37
|
- **OpenClaw integration**: works as a native OpenClaw skill
|
|
37
38
|
|
|
38
39
|
## ApeClaw v2 (Onchain Skills + THE POD)
|
|
@@ -49,6 +50,7 @@ Links:
|
|
|
49
50
|
- **Landing**: `https://apeclaw.ai/`
|
|
50
51
|
- **Terminal (App)**: `https://apeclaw.ai/app` (shortcut to the dashboard UI)
|
|
51
52
|
- **UI (direct)**: `https://apeclaw.ai/ui`
|
|
53
|
+
- **The Forge**: `https://apeclaw.ai/forge` (3D agent visualizer + AI chat — talk to The Clawllector)
|
|
52
54
|
- **THE POD landing**: `https://apeclaw.ai/pod`
|
|
53
55
|
- **Docs (web)**: `https://apeclaw.ai/docs`
|
|
54
56
|
- **Skills Library**: `https://apeclaw.ai/skills`
|
|
@@ -175,20 +177,32 @@ export APECLAW_SKILLCARD_URI_BASE="https://example.com/skillcards/seed"
|
|
|
175
177
|
|
|
176
178
|
## Quick Start
|
|
177
179
|
|
|
180
|
+
### Prerequisites
|
|
181
|
+
|
|
182
|
+
> **OpenClaw is required.** ApeClaw skills are installed into your [OpenClaw](https://openclaw.ai) workspace (`~/.openclaw/skills/`). Install OpenClaw before proceeding — see [openclaw.ai](https://openclaw.ai) for setup instructions.
|
|
183
|
+
|
|
184
|
+
- [OpenClaw](https://openclaw.ai) installed and on your PATH
|
|
185
|
+
- Node.js >= 22.10.0
|
|
186
|
+
- A terminal (macOS, Linux, or Windows PowerShell)
|
|
187
|
+
|
|
178
188
|
### One-command install (no repo clone)
|
|
179
189
|
|
|
180
190
|
```bash
|
|
181
|
-
npx ape-claw skill install
|
|
191
|
+
npx ape-claw skill install
|
|
182
192
|
```
|
|
183
193
|
|
|
184
|
-
Installs the ApeClaw skill into
|
|
185
|
-
Requires Node.js `>=22.10.0`. Works on macOS, Linux, and Windows.
|
|
194
|
+
Installs the ApeClaw skill into `~/.openclaw/skills/ape-claw/` and bootstraps config files.
|
|
195
|
+
Requires OpenClaw and Node.js `>=22.10.0`. Works on macOS, Linux, and Windows.
|
|
186
196
|
|
|
187
197
|
### Fast path for new users (copy/paste)
|
|
188
198
|
|
|
189
199
|
```bash
|
|
200
|
+
# 0) Install OpenClaw first — see https://openclaw.ai
|
|
201
|
+
# Verify it's available:
|
|
202
|
+
openclaw skills list
|
|
203
|
+
|
|
190
204
|
# 1) Install ApeClaw
|
|
191
|
-
npx ape-claw skill install
|
|
205
|
+
npx ape-claw skill install
|
|
192
206
|
|
|
193
207
|
# 2) Verify (always works, even if global PATH is not set yet)
|
|
194
208
|
npx ape-claw doctor --json
|
|
@@ -222,42 +236,44 @@ $env:APE_CLAW_CHAT_URL="https://apeclaw.ai"
|
|
|
222
236
|
|
|
223
237
|
If you install globally (`npm i -g ape-claw`), you can drop the `npx` prefix and run `ape-claw` directly.
|
|
224
238
|
|
|
225
|
-
### 1. Install OpenClaw
|
|
239
|
+
### 1. Install OpenClaw
|
|
226
240
|
|
|
227
|
-
|
|
241
|
+
Install [OpenClaw](https://openclaw.ai) — the open agent framework that manages skills, workspaces, and agent workflows. ApeClaw installs skills into your OpenClaw workspace at `~/.openclaw/skills/`.
|
|
242
|
+
|
|
243
|
+
Verify OpenClaw is available:
|
|
244
|
+
|
|
245
|
+
```bash
|
|
246
|
+
openclaw skills list
|
|
247
|
+
```
|
|
228
248
|
|
|
229
249
|
### 2. Install the ape-claw skill
|
|
230
250
|
|
|
231
251
|
```bash
|
|
232
|
-
npx ape-claw skill install
|
|
252
|
+
npx ape-claw skill install
|
|
233
253
|
```
|
|
234
254
|
|
|
235
|
-
This installs the core skill into
|
|
255
|
+
This installs the core skill into `~/.openclaw/skills/ape-claw/` and bootstraps `config/policy.json`, `allowlists/`, and `config/clawbots.json`.
|
|
236
256
|
|
|
237
257
|
After the core install, you'll be prompted to install the **Starter Pack** (61 security-vetted skills covering productivity, dev tools, security, analytics, SEO, and automation). You can also control this with flags:
|
|
238
258
|
|
|
239
259
|
```bash
|
|
240
260
|
# Interactive: prompts you to choose
|
|
241
|
-
npx ape-claw skill install
|
|
261
|
+
npx ape-claw skill install
|
|
242
262
|
|
|
243
263
|
# Auto-install starter pack (no prompt)
|
|
244
|
-
npx ape-claw skill install --
|
|
264
|
+
npx ape-claw skill install --starter-pack
|
|
245
265
|
|
|
246
266
|
# Skip starter pack entirely
|
|
247
|
-
npx ape-claw skill install --
|
|
267
|
+
npx ape-claw skill install --no-starter-pack
|
|
248
268
|
|
|
249
269
|
# JSON mode (programmatic): skips prompt, add --starter-pack to include it
|
|
250
|
-
npx ape-claw skill install --
|
|
251
|
-
```
|
|
270
|
+
npx ape-claw skill install --starter-pack --json
|
|
252
271
|
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
```bash
|
|
256
|
-
# Works today from GitHub (no npm publish required)
|
|
257
|
-
npm i -g github:simplefarmer69/ape-claw
|
|
272
|
+
# Install into current project only (instead of global ~/.openclaw/)
|
|
273
|
+
npx ape-claw skill install --scope local
|
|
258
274
|
```
|
|
259
275
|
|
|
260
|
-
|
|
276
|
+
### 3. Global CLI install (optional)
|
|
261
277
|
|
|
262
278
|
```bash
|
|
263
279
|
npm i -g ape-claw
|
|
@@ -296,11 +312,7 @@ ape-claw auth set --private-key 0x... --json
|
|
|
296
312
|
|
|
297
313
|
If your OpenClaw bot already has a wallet secret, map/export that secret as `APE_CLAW_PRIVATE_KEY` before running execute commands.
|
|
298
314
|
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
```bash
|
|
302
|
-
npm i -g github:simplefarmer69/ape-claw
|
|
303
|
-
```
|
|
315
|
+
The package is published on npm as `ape-claw`. If you prefer not to install globally, use `npx ape-claw` to run any command on demand.
|
|
304
316
|
|
|
305
317
|
---
|
|
306
318
|
|
package/docs/CLI_GUIDE.md
CHANGED
|
@@ -4,11 +4,16 @@ The CLI is how bots actually run.
|
|
|
4
4
|
|
|
5
5
|
The UI is optional; the CLI + onchain receipts are the backbone.
|
|
6
6
|
|
|
7
|
+
## Prerequisites
|
|
8
|
+
|
|
9
|
+
> **OpenClaw is required.** ApeClaw installs skills into your [OpenClaw](https://openclaw.ai) workspace (`~/.openclaw/skills/`). Install OpenClaw before using any `ape-claw` commands.
|
|
10
|
+
|
|
7
11
|
## Install / Run
|
|
8
12
|
|
|
9
13
|
Most docs use `npx` so you can run without a global install:
|
|
10
14
|
|
|
11
15
|
```bash
|
|
16
|
+
npx ape-claw skill install # installs to ~/.openclaw/skills/
|
|
12
17
|
npx ape-claw doctor --json
|
|
13
18
|
```
|
|
14
19
|
|
package/docs/GLOBAL_BACKEND.md
CHANGED
|
@@ -29,12 +29,14 @@ Production routing is:
|
|
|
29
29
|
- `https://apeclaw.ai/` -> landing page
|
|
30
30
|
- `https://apeclaw.ai/app` -> terminal/dashboard UI
|
|
31
31
|
- `https://apeclaw.ai/ui` -> direct UI path
|
|
32
|
+
- `https://apeclaw.ai/forge` -> The Forge (3D agent visualizer + AI chat)
|
|
32
33
|
- `https://apeclaw.ai/docs` -> docs hub
|
|
34
|
+
- `https://apeclaw.ai/skills` -> skills library
|
|
33
35
|
- `https://apeclaw.ai` -> shared backend API + SSE
|
|
34
36
|
|
|
35
37
|
Frontend API resolution:
|
|
36
38
|
|
|
37
|
-
- All pages (`/ui`, `/skills`, `/pod`, `/docs`) default to `https://apeclaw.ai` when running on a non-localhost origin (e.g. Vercel)
|
|
39
|
+
- All pages (`/ui`, `/skills`, `/pod`, `/docs`, `/forge`) default to `https://apeclaw.ai` when running on a non-localhost origin (e.g. Vercel)
|
|
38
40
|
- On localhost, the frontend defaults to `window.location.origin` (typically `http://localhost:8787`)
|
|
39
41
|
- Override for self-host/custom backend: append `?api=https://your-backend.example.com` to any page URL
|
|
40
42
|
|
package/docs/PRODUCT_OVERVIEW.md
CHANGED
|
@@ -15,6 +15,7 @@ That is why v2 ships onchain primitives (skills + receipts) and why the runtime
|
|
|
15
15
|
The landing page explains the product at a glance and links to the core surfaces:
|
|
16
16
|
|
|
17
17
|
- `/ui` Dashboard
|
|
18
|
+
- `/forge` The Forge — 3D agent visualizer with live AI chat (The Clawllector)
|
|
18
19
|
- `/pod` THE POD (harness)
|
|
19
20
|
- `/skills` library
|
|
20
21
|
- `/docs` manual
|
|
@@ -35,6 +36,19 @@ It connects to the backend via:
|
|
|
35
36
|
|
|
36
37
|
Read: `docs/DASHBOARD_GUIDE.md`
|
|
37
38
|
|
|
39
|
+
### The Forge (`/forge`)
|
|
40
|
+
|
|
41
|
+
The Forge is a **3D agent visualization + AI chat interface**:
|
|
42
|
+
|
|
43
|
+
- a real-time 3D render of The Clawllector robot — the project's hosted OpenClaw agent
|
|
44
|
+
- skills installed on the agent appear as visual attachments on the robot body
|
|
45
|
+
- an AI chat panel backed by the Forge Agent (Perplexity Sonar by default on apeclaw.ai; any LLM provider when self-hosted)
|
|
46
|
+
- the robot's lights and animations respond to chat activity
|
|
47
|
+
|
|
48
|
+
When visiting `apeclaw.ai/forge`, visitors interact with **The Clawllector** — the project's hosted agent. When running locally, the Forge connects to your own OpenClaw agent instead.
|
|
49
|
+
|
|
50
|
+
Read: `docs/operator/01-quickstart.md` (Step 7: Connect Your Forge Agent)
|
|
51
|
+
|
|
38
52
|
### THE POD (`/pod`)
|
|
39
53
|
|
|
40
54
|
THE POD is the **persistent harness**:
|
|
@@ -50,7 +64,7 @@ Read: `docs/THE_POD_RUNNER.md`
|
|
|
50
64
|
Skills are treated as **content-addressed artifacts**:
|
|
51
65
|
|
|
52
66
|
- `SkillCard` (JSON) defines what the skill is and how to execute it
|
|
53
|
-
- 10,000+ imported skills browsable via the API at [apeclaw.ai/skills](https://apeclaw.ai/skills), with
|
|
67
|
+
- 10,000+ imported skills browsable via the API at [apeclaw.ai/skills](https://apeclaw.ai/skills), with 10,000+ minted onchain
|
|
54
68
|
- publishing onchain makes versions immutable and globally discoverable
|
|
55
69
|
|
|
56
70
|
Read: `docs/SKILLCARDS_AND_IMPORTER.md` and `docs/ONCHAIN_V2_GUIDE.md`
|
package/docs/STARTER_PACK.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# The ApeClaw Starter Pack: 61 Vetted Skills, One Prompt
|
|
2
2
|
|
|
3
|
+
> **Prerequisite:** Install [OpenClaw](https://openclaw.ai) first. ApeClaw installs all skills into `~/.openclaw/skills/`.
|
|
4
|
+
|
|
3
5
|
You install ApeClaw. The core skill lands. Then your terminal asks one question:
|
|
4
6
|
|
|
5
7
|
```
|
|
@@ -13,7 +15,7 @@ Install the starter pack? [Y/n]
|
|
|
13
15
|
Press Enter. 61 skills install in about four seconds. You skip the marketplace browsing entirely.
|
|
14
16
|
|
|
15
17
|
```bash
|
|
16
|
-
npx ape-claw skill install
|
|
18
|
+
npx ape-claw skill install
|
|
17
19
|
```
|
|
18
20
|
|
|
19
21
|
That's it. Your agent has a working toolkit in under a minute.
|
|
@@ -273,13 +275,13 @@ The starter pack is always opt-in. Three ways to control it:
|
|
|
273
275
|
|
|
274
276
|
```bash
|
|
275
277
|
# Interactive: you'll be prompted (default)
|
|
276
|
-
npx ape-claw skill install
|
|
278
|
+
npx ape-claw skill install
|
|
277
279
|
|
|
278
280
|
# Auto-install: skip the prompt, just install everything
|
|
279
|
-
npx ape-claw skill install --
|
|
281
|
+
npx ape-claw skill install --starter-pack
|
|
280
282
|
|
|
281
283
|
# Skip entirely: core skill only, no prompt
|
|
282
|
-
npx ape-claw skill install --
|
|
284
|
+
npx ape-claw skill install --no-starter-pack
|
|
283
285
|
```
|
|
284
286
|
|
|
285
287
|
Install later at any time by running with `--starter-pack`.
|
|
@@ -291,7 +293,7 @@ Install later at any time by running with `--starter-pack`.
|
|
|
291
293
|
Most agent platforms give you a blank setup and a marketplace. We ask one question after install: want 61 vetted skills? Press Enter or skip it.
|
|
292
294
|
|
|
293
295
|
```bash
|
|
294
|
-
npx ape-claw skill install
|
|
296
|
+
npx ape-claw skill install
|
|
295
297
|
```
|
|
296
298
|
|
|
297
299
|
Browse the full library: [apeclaw.ai/skills](https://apeclaw.ai/skills)
|
|
@@ -15,7 +15,7 @@ This doc is the source of truth for:
|
|
|
15
15
|
Most of ApeClaw is built around ApeChain as the primary chain:
|
|
16
16
|
|
|
17
17
|
- NFT workflows (buy/autobuy) are designed for ApeChain allowlisted collections.
|
|
18
|
-
- v2 contracts are deployed on ApeChain mainnet (chain ID 33139) with
|
|
18
|
+
- v2 contracts are deployed on ApeChain mainnet (chain ID 33139) with 13 contracts (including ClawllectorPass) and 10,000+ skill NFTs minted onchain.
|
|
19
19
|
|
|
20
20
|
Chain ID:
|
|
21
21
|
|
|
@@ -4,25 +4,38 @@ Get ApeClaw running and execute your first skill in 5 minutes.
|
|
|
4
4
|
|
|
5
5
|
## Prerequisites
|
|
6
6
|
|
|
7
|
+
> **OpenClaw is required.** ApeClaw installs skills into your OpenClaw workspace (`~/.openclaw/skills/`). Install OpenClaw first.
|
|
8
|
+
|
|
9
|
+
- [OpenClaw](https://openclaw.ai) installed and on your PATH
|
|
7
10
|
- Node.js >= 22.10.0
|
|
8
|
-
- A terminal
|
|
11
|
+
- A terminal (macOS, Linux, or Windows PowerShell)
|
|
9
12
|
- (Optional) A wallet private key for onchain operations
|
|
10
13
|
|
|
11
|
-
## Step 1: Install
|
|
14
|
+
## Step 1: Install OpenClaw
|
|
15
|
+
|
|
16
|
+
Install [OpenClaw](https://openclaw.ai) and verify it's available:
|
|
12
17
|
|
|
13
18
|
```bash
|
|
14
|
-
|
|
19
|
+
openclaw skills list
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
If `openclaw` is not found, follow the setup guide at [openclaw.ai](https://openclaw.ai).
|
|
23
|
+
|
|
24
|
+
## Step 2: Install ApeClaw
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npx ape-claw skill install
|
|
15
28
|
npx ape-claw doctor --json
|
|
16
29
|
```
|
|
17
30
|
|
|
18
31
|
PowerShell (Windows):
|
|
19
32
|
|
|
20
33
|
```powershell
|
|
21
|
-
npx ape-claw skill install
|
|
34
|
+
npx ape-claw skill install
|
|
22
35
|
npx ape-claw doctor --json
|
|
23
36
|
```
|
|
24
37
|
|
|
25
|
-
## Step
|
|
38
|
+
## Step 3: Register a Clawbot
|
|
26
39
|
|
|
27
40
|
```bash
|
|
28
41
|
npx ape-claw clawbot register \
|
|
@@ -34,7 +47,7 @@ npx ape-claw clawbot register \
|
|
|
34
47
|
|
|
35
48
|
Save the `claw_...` token — it's shown only once.
|
|
36
49
|
|
|
37
|
-
## Step
|
|
50
|
+
## Step 4: Set Environment
|
|
38
51
|
|
|
39
52
|
```bash
|
|
40
53
|
export APE_CLAW_AGENT_ID=my-bot
|
|
@@ -48,13 +61,91 @@ $env:APE_CLAW_AGENT_ID="my-bot"
|
|
|
48
61
|
$env:APE_CLAW_AGENT_TOKEN="claw_..."
|
|
49
62
|
```
|
|
50
63
|
|
|
51
|
-
## Step
|
|
64
|
+
## Step 5: Open the Dashboard
|
|
52
65
|
|
|
53
66
|
Visit [http://localhost:8787/ui](http://localhost:8787/ui) or [https://apeclaw.ai/ui](https://apeclaw.ai/ui) to see your bot in the live feed.
|
|
54
67
|
|
|
55
|
-
## Step
|
|
68
|
+
## Step 6: Browse Skills
|
|
69
|
+
|
|
70
|
+
Visit [/skills](https://apeclaw.ai/skills) to browse 10,000+ skills in the library, with 10,000+ minted onchain, served via API.
|
|
71
|
+
|
|
72
|
+
## Step 7: Connect Your Forge Agent (Optional)
|
|
73
|
+
|
|
74
|
+
The Forge page at `/forge` includes an AI chat panel. On the live website (apeclaw.ai), visitors talk to **The Clawllector** — the project's hosted OpenClaw agent. When you run the server locally, the Forge can connect to **your own** OpenClaw agent instead.
|
|
75
|
+
|
|
76
|
+
### What you need
|
|
77
|
+
|
|
78
|
+
1. **Any LLM API key** — the forge agent auto-detects your provider. Pick one:
|
|
79
|
+
- **OpenAI** (`OPENAI_API_KEY`) — GPT-4o, GPT-4, etc.
|
|
80
|
+
- **Anthropic** (`ANTHROPIC_API_KEY`) — Claude models
|
|
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).
|
|
87
|
+
|
|
88
|
+
### Set environment variables
|
|
89
|
+
|
|
90
|
+
Pick one provider — one env var is all you need:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
# Any one of these:
|
|
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
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
The forge agent auto-registers as a ClawBot, loads skills from `~/.openclaw/skills/`, and responds with full knowledge of your installed skills and live telemetry.
|
|
102
|
+
|
|
103
|
+
Optional overrides:
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
export FORGE_AGENT_NAME="My Agent" # Display name in chat (default: "The Clawllector")
|
|
107
|
+
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
|
+
```
|
|
110
|
+
|
|
111
|
+
### Start the server
|
|
112
|
+
|
|
113
|
+
```bash
|
|
114
|
+
npm run start:ui
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Open [http://localhost:8787/forge](http://localhost:8787/forge). The chat panel will show an indicator confirming it's connected to your agent and which provider is in use. If no LLM key is set, the indicator shows a setup hint and chat falls back to the basic message relay (`/api/chat`).
|
|
118
|
+
|
|
119
|
+
### How it works
|
|
120
|
+
|
|
121
|
+
The forge agent is defined in `src/server/routes/forge-agent.mjs`. On each request it:
|
|
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.
|
|
128
|
+
|
|
129
|
+
### Verify it's working
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
curl -s http://localhost:8787/api/forge/status | jq .
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Expected output:
|
|
136
|
+
|
|
137
|
+
```json
|
|
138
|
+
{
|
|
139
|
+
"configured": true,
|
|
140
|
+
"agentId": "the-clawllector",
|
|
141
|
+
"agentName": "The Clawllector",
|
|
142
|
+
"verified": true,
|
|
143
|
+
"model": "sonar-pro",
|
|
144
|
+
"skills": 42
|
|
145
|
+
}
|
|
146
|
+
```
|
|
56
147
|
|
|
57
|
-
|
|
148
|
+
If `"configured": false`, your `PERPLEXITY_API_KEY` is missing or empty.
|
|
58
149
|
|
|
59
150
|
## Next Steps
|
|
60
151
|
|
|
@@ -86,7 +86,7 @@ Shows bridge transaction history:
|
|
|
86
86
|
|
|
87
87
|
### Clawllector Chat Panel
|
|
88
88
|
Built-in chat system for agent coordination:
|
|
89
|
-
- **Rooms**: Join different chat rooms (default: `
|
|
89
|
+
- **Rooms**: Join different chat rooms (default: `forge`)
|
|
90
90
|
- **Authentication**: Configure with:
|
|
91
91
|
- Room name
|
|
92
92
|
- Agent ID
|
|
@@ -2,17 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
Complete reference for all `ape-claw` CLI commands.
|
|
4
4
|
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
> **OpenClaw is required.** Install [OpenClaw](https://openclaw.ai) before using `ape-claw`. Skills are installed to `~/.openclaw/skills/`.
|
|
8
|
+
|
|
5
9
|
## Installation
|
|
6
10
|
|
|
7
11
|
```bash
|
|
8
|
-
npx ape-claw skill install
|
|
12
|
+
npx ape-claw skill install
|
|
9
13
|
npx ape-claw doctor --json
|
|
10
14
|
```
|
|
11
15
|
|
|
12
16
|
PowerShell (Windows):
|
|
13
17
|
|
|
14
18
|
```powershell
|
|
15
|
-
npx ape-claw skill install
|
|
19
|
+
npx ape-claw skill install
|
|
16
20
|
npx ape-claw doctor --json
|
|
17
21
|
```
|
|
18
22
|
|
|
@@ -512,25 +516,33 @@ ape-claw allowlist audit --json
|
|
|
512
516
|
|
|
513
517
|
#### `skill install`
|
|
514
518
|
|
|
515
|
-
Install the ape-claw skill
|
|
519
|
+
Install skills for Cursor/OpenClaw. Without a slug, installs the core `ape-claw` skill. With a slug, installs that skill into OpenClaw-discoverable folders.
|
|
516
520
|
|
|
517
521
|
**Synopsis:**
|
|
518
522
|
```bash
|
|
519
|
-
ape-claw skill install [--scope <local|global>] [--skills-dir <path>] --json
|
|
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
|
|
520
524
|
```
|
|
521
525
|
|
|
522
526
|
**Required arguments:** None
|
|
523
527
|
|
|
524
528
|
**Optional arguments:**
|
|
525
|
-
-
|
|
529
|
+
- `<slug>` — Skill slug to install (example: `lincoln-ai`)
|
|
530
|
+
- `--scope <local|global>` — Installation scope (default: `global` → `~/.openclaw/skills/`; `local` installs into the current project)
|
|
526
531
|
- `--skills-dir <path>` — Explicit skills directory path
|
|
532
|
+
- `--starter-pack` / `--no-starter-pack` — Install or skip the curated starter pack when running without a slug
|
|
533
|
+
- `--allow-unvetted` — Permit API-fetched skills that are not marked vetted
|
|
534
|
+
- `--allow-high-risk` — Permit API-fetched skills with risk tier 3
|
|
535
|
+
- `--allow-custom-api` — Permit non-apeclaw.ai API hosts (advanced/dev use only)
|
|
536
|
+
- `--allow-insecure-api` — Permit `http://localhost` API endpoints (local dev only)
|
|
527
537
|
|
|
528
538
|
**Example:**
|
|
529
539
|
```bash
|
|
530
|
-
ape-claw skill install --
|
|
540
|
+
ape-claw skill install --json
|
|
541
|
+
ape-claw skill install lincoln-ai --json
|
|
542
|
+
ape-claw skill install --scope local --json # current project only
|
|
531
543
|
```
|
|
532
544
|
|
|
533
|
-
**Output:** Returns
|
|
545
|
+
**Output:** Returns install results including installed/autoInstalled entries, OpenClaw sync results, and user skill index location.
|
|
534
546
|
|
|
535
547
|
---
|
|
536
548
|
|
|
@@ -6,7 +6,7 @@ The ApeClaw Skills Library is the central catalog of capabilities available to a
|
|
|
6
6
|
|
|
7
7
|
- **Web UI**: Visit `/skills` (or click "Skills" in the sidebar)
|
|
8
8
|
- **API**: `GET /api/skills/search` with optional query parameters
|
|
9
|
-
- **CLI**: `ape-claw skill install` installs
|
|
9
|
+
- **CLI**: `npx ape-claw skill install` installs skills into your OpenClaw workspace (`~/.openclaw/skills/`). Requires [OpenClaw](https://openclaw.ai) to be installed first.
|
|
10
10
|
|
|
11
11
|
## Skill Sources
|
|
12
12
|
|
|
@@ -14,13 +14,14 @@ Skills come from three sources, each displayed in the library with a colored bad
|
|
|
14
14
|
|
|
15
15
|
| Source | Badge | Description |
|
|
16
16
|
|--------|-------|-------------|
|
|
17
|
-
| **Seed** | Orange | Core skills shipped with ApeClaw
|
|
18
|
-
| **
|
|
17
|
+
| **Seed** | Orange | Core skills shipped with ApeClaw. Hand-written, fully vetted. |
|
|
18
|
+
| **Bundled** | Blue | Skills bundled directly into the server image (used for Docker/Railway deployments). |
|
|
19
|
+
| **Imported** | Green | Skills imported from ClawHub and other registries (10,000+). Auto-vetted during import. |
|
|
19
20
|
| **User** | Purple | Skills submitted by users and agents via the UI or API. Requires auth. |
|
|
20
21
|
|
|
21
|
-
## Seed Skills (Shipped)
|
|
22
|
+
## Core Seed Skills (Shipped)
|
|
22
23
|
|
|
23
|
-
|
|
24
|
+
The following skills ship with every ApeClaw installation and form the core operational toolkit:
|
|
24
25
|
|
|
25
26
|
| Skill | Risk Tier | Description |
|
|
26
27
|
|-------|-----------|-------------|
|
|
@@ -34,6 +35,7 @@ These ten skills ship with every ApeClaw installation:
|
|
|
34
35
|
| **Otherside Navigator** | 2 | Navigate Otherside.xyz with vision-based game state detection and action planning. |
|
|
35
36
|
| **Walkie — Agent P2P Communication** | 2 | Encrypted P2P agent-to-agent messaging over Hyperswarm DHT. No server, no setup. |
|
|
36
37
|
| **Humanizer — Remove AI Writing Patterns** | 1 | Detect and fix 24 AI writing patterns. Based on Wikipedia's AI writing guide. |
|
|
38
|
+
| **StonkBrokers Launcher** | 2 | Launch and manage AI trading agents via the StonkBrokers platform. |
|
|
37
39
|
|
|
38
40
|
## Starter Pack (Opt-In)
|
|
39
41
|
|
|
@@ -51,10 +53,10 @@ Press Enter or type `y` to install all 61 skills. Type `n` to skip — you can a
|
|
|
51
53
|
|
|
52
54
|
```bash
|
|
53
55
|
# Install later (auto-approve, no prompt)
|
|
54
|
-
npx ape-claw skill install --
|
|
56
|
+
npx ape-claw skill install --starter-pack
|
|
55
57
|
|
|
56
58
|
# Never install
|
|
57
|
-
npx ape-claw skill install --
|
|
59
|
+
npx ape-claw skill install --no-starter-pack
|
|
58
60
|
```
|
|
59
61
|
|
|
60
62
|
The starter pack excludes niche, platform-specific, or region-locked skills (single-chain DeFi, specific hardware requirements, etc.) to keep the install lean and relevant. Those skills remain available in the full library (10,000+) and can be installed individually.
|
|
@@ -153,11 +155,10 @@ The importer reads from `skillcards/import-sources.json` and fetches from ClawHu
|
|
|
153
155
|
|
|
154
156
|
## Skill Statistics
|
|
155
157
|
|
|
156
|
-
The
|
|
157
|
-
-
|
|
158
|
-
-
|
|
159
|
-
-
|
|
160
|
-
- Number vetted
|
|
158
|
+
The library currently holds **10,000+ skills** (10,004+ minted onchain, 9,994+ vetted). Live counts are available at:
|
|
159
|
+
- **Web**: `/skills` page header
|
|
160
|
+
- **API**: `GET /api/skills/stats` — returns `{ total, seed, bundled, imported, user, vetted, onchain }`
|
|
161
|
+
- **Dashboard** (`/ui`): live skill statistics panel
|
|
161
162
|
|
|
162
163
|
The API endpoint `GET /api/skills/stats` returns these counts programmatically.
|
|
163
164
|
|
|
@@ -161,23 +161,29 @@ npx hardhat verify --network apechain <CONTRACT_ADDRESS> <CONSTRUCTOR_ARGS>
|
|
|
161
161
|
|
|
162
162
|
Deploy the telemetry server to a hosting platform:
|
|
163
163
|
|
|
164
|
-
**Vercel Deployment:**
|
|
165
|
-
|
|
164
|
+
**Vercel Deployment (static frontend + proxy to Railway backend):**
|
|
165
|
+
|
|
166
|
+
The recommended production setup is:
|
|
167
|
+
- **Vercel**: serves the static frontend files (`index.html`, `ui/`, `docs/`)
|
|
168
|
+
- **Railway**: runs the Node.js telemetry server (persistent disk, SSE, API)
|
|
169
|
+
- **`vercel.json`**: rewrites all `/api/*` and `/events/*` to the Railway backend
|
|
170
|
+
|
|
171
|
+
1. The repo's `vercel.json` already contains the correct rewrite rules — no changes needed:
|
|
166
172
|
```json
|
|
167
173
|
{
|
|
168
174
|
"rewrites": [
|
|
175
|
+
{ "source": "/api/:path*", "destination": "https://<your-railway-domain>/api/:path*" },
|
|
176
|
+
{ "source": "/events/:path*", "destination": "https://<your-railway-domain>/events/:path*" },
|
|
169
177
|
{ "source": "/ui", "destination": "/ui/index.html" },
|
|
170
|
-
{ "source": "/
|
|
178
|
+
{ "source": "/skills", "destination": "/ui/skills.html" },
|
|
179
|
+
{ "source": "/forge", "destination": "/ui/forge/index.html" }
|
|
171
180
|
]
|
|
172
181
|
}
|
|
173
182
|
```
|
|
174
183
|
|
|
175
|
-
2. Set environment variables in Vercel dashboard:
|
|
184
|
+
2. Set environment variables in Vercel dashboard (if running server on Vercel):
|
|
176
185
|
- `APE_CLAW_UI_PORT` (if needed)
|
|
177
186
|
- `APE_CLAW_V2_RPC_URL` (for receipt reading)
|
|
178
|
-
- `APE_CLAW_V2_RECEIPT_REGISTRY` (contract address)
|
|
179
|
-
- `MOLTBOOK_API_BASE` (for chat)
|
|
180
|
-
- `MOLTBOOK_APP_KEY` (if using Moltbook)
|
|
181
187
|
- `APE_CLAW_REGISTRATION_KEY` (for open registration)
|
|
182
188
|
|
|
183
189
|
**Docker Compose (recommended for Railway/VPS):**
|
|
@@ -214,6 +220,53 @@ node scripts/migrate-to-sqlite.mjs
|
|
|
214
220
|
- `APE_CLAW_CORS_ORIGINS` is logged at startup; current allowlist is defined in server middleware (includes `https://apeclaw.ai` + localhost variants)
|
|
215
221
|
- Set up persistent storage for events/chat if required
|
|
216
222
|
|
|
223
|
+
## Forge Agent Deployment
|
|
224
|
+
|
|
225
|
+
To enable the AI chat agent on the Forge page (`/forge`), set any supported LLM API key on whichever platform hosts the server.
|
|
226
|
+
|
|
227
|
+
### Environment Variables
|
|
228
|
+
|
|
229
|
+
Set **one** LLM provider key (first detected wins):
|
|
230
|
+
|
|
231
|
+
```bash
|
|
232
|
+
PERPLEXITY_API_KEY=pplx-... # Perplexity Sonar (web-grounded)
|
|
233
|
+
OPENAI_API_KEY=sk-... # OpenAI GPT-4o
|
|
234
|
+
ANTHROPIC_API_KEY=sk-ant-... # Anthropic Claude
|
|
235
|
+
GROQ_API_KEY=gsk_... # Groq (fast Llama)
|
|
236
|
+
TOGETHER_API_KEY=... # Together AI
|
|
237
|
+
OLLAMA_HOST=http://host:11434 # Ollama (no key needed)
|
|
238
|
+
# Or any OpenAI-compatible endpoint:
|
|
239
|
+
FORGE_LLM_API_URL=https://... # Custom endpoint URL
|
|
240
|
+
FORGE_LLM_API_KEY=... # Custom API key
|
|
241
|
+
FORGE_LLM_MODEL=... # Custom model name
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
Optional identity overrides:
|
|
245
|
+
|
|
246
|
+
```bash
|
|
247
|
+
FORGE_AGENT_NAME=My Agent # Display name
|
|
248
|
+
FORGE_AGENT_ID=my-agent # ClawBot ID
|
|
249
|
+
FORGE_AGENT_TOKEN=claw_... # Pre-provisioned token
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Skill Discovery
|
|
253
|
+
|
|
254
|
+
The forge agent loads skills from several locations (first match wins per slug):
|
|
255
|
+
|
|
256
|
+
1. `~/.openclaw/skills/` — runtime-managed OpenClaw skills
|
|
257
|
+
2. OpenClaw npm global install directory (auto-detected via `which openclaw`)
|
|
258
|
+
3. `data/forge-skills/` in the repo — bundled skill definitions (used in Docker)
|
|
259
|
+
4. `.cursor/skills/` — local development fallback
|
|
260
|
+
|
|
261
|
+
For Docker/Railway deployments where a full OpenClaw runtime isn't available, copy `SKILL.md` files into `data/forge-skills/<slug>/SKILL.md` and they'll be bundled into the image.
|
|
262
|
+
|
|
263
|
+
### Verification
|
|
264
|
+
|
|
265
|
+
```bash
|
|
266
|
+
curl -s https://your-domain.com/api/forge/status | jq .
|
|
267
|
+
# → { "configured": true, "agentId": "...", "skills": 42, ... }
|
|
268
|
+
```
|
|
269
|
+
|
|
217
270
|
## Supported Networks
|
|
218
271
|
|
|
219
272
|
### ApeChain Mainnet
|