shaunx Claude Opus 4.6 commited on
Commit
dc4a73c
·
1 Parent(s): 7936d3a

docs: add hints for finding API key and gateway token

Browse files

- README: fix App Store .env path to actual location under ~/Library/...
- README: add "Where to find these values" section with tips
- README: note gateway.auth.token path in Configuration section
- .env.example: fix token path (gateway.auth.token, not gateway.token)
- .env.example: add tip about copying API key from Conversation app

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Files changed (2) hide show
  1. .env.example +3 -1
  2. README.md +10 -4
.env.example CHANGED
@@ -6,6 +6,8 @@
6
  # ==============================================================================
7
  # Get your key at: https://platform.openai.com/api-keys
8
  # Requires Realtime API access
 
 
9
  OPENAI_API_KEY=sk-your-openai-key
10
 
11
  # ==============================================================================
@@ -16,7 +18,7 @@ OPENAI_API_KEY=sk-your-openai-key
16
  OPENCLAW_GATEWAY_URL=http://192.168.1.100:18789
17
 
18
  # Your OpenClaw gateway authentication token
19
- # Find this in ~/.openclaw/openclaw.json under gateway.token
20
  OPENCLAW_TOKEN=your-gateway-token
21
 
22
  # Agent ID to use (default: main)
 
6
  # ==============================================================================
7
  # Get your key at: https://platform.openai.com/api-keys
8
  # Requires Realtime API access
9
+ # Tip: If you already have the Conversation app installed, you can copy the key
10
+ # from its .env (same venv path, under the conversation_venv directory).
11
  OPENAI_API_KEY=sk-your-openai-key
12
 
13
  # ==============================================================================
 
18
  OPENCLAW_GATEWAY_URL=http://192.168.1.100:18789
19
 
20
  # Your OpenClaw gateway authentication token
21
+ # Find this in ~/.openclaw/openclaw.json under gateway.auth.token
22
  OPENCLAW_TOKEN=your-gateway-token
23
 
24
  # Agent ID to use (default: main)
README.md CHANGED
@@ -93,13 +93,13 @@ Install ReachyClaw directly from the Reachy Mini Control app. After installation
93
  The file goes here (on macOS):
94
 
95
  ```
96
- /Applications/Reachy Mini Control.app/Contents/Resources/reachyclaw_venv/lib/python3.12/.env
97
  ```
98
 
99
  Create it with:
100
 
101
  ```bash
102
- cat > "/Applications/Reachy Mini Control.app/Contents/Resources/reachyclaw_venv/lib/python3.12/.env" << EOF
103
  OPENAI_API_KEY=sk-...your-key...
104
  OPENCLAW_GATEWAY_URL=ws://localhost:18789
105
  OPENCLAW_TOKEN=your-gateway-token
@@ -107,6 +107,12 @@ OPENCLAW_AGENT_ID=main
107
  EOF
108
  ```
109
 
 
 
 
 
 
 
110
  That's it — launch ReachyClaw from the app and it will work.
111
 
112
  ### From Source (CLI / development)
@@ -130,7 +136,7 @@ cp .env.example .env
130
 
131
  ## Configuration
132
 
133
- Edit `.env`:
134
 
135
  ```bash
136
  # Required
@@ -138,7 +144,7 @@ OPENAI_API_KEY=sk-...your-key...
138
 
139
  # OpenClaw Gateway (required)
140
  OPENCLAW_GATEWAY_URL=ws://localhost:18789
141
- OPENCLAW_TOKEN=your-gateway-token
142
  OPENCLAW_AGENT_ID=main
143
 
144
  # Optional
 
93
  The file goes here (on macOS):
94
 
95
  ```
96
+ ~/Library/Application Support/com.pollen-robotics.reachy-mini/reachyclaw_venv/lib/python3.12/.env
97
  ```
98
 
99
  Create it with:
100
 
101
  ```bash
102
+ cat > ~/Library/Application\ Support/com.pollen-robotics.reachy-mini/reachyclaw_venv/lib/python3.12/.env << EOF
103
  OPENAI_API_KEY=sk-...your-key...
104
  OPENCLAW_GATEWAY_URL=ws://localhost:18789
105
  OPENCLAW_TOKEN=your-gateway-token
 
107
  EOF
108
  ```
109
 
110
+ **Where to find these values:**
111
+
112
+ - **`OPENAI_API_KEY`** — from [platform.openai.com/api-keys](https://platform.openai.com/api-keys). If you already have the Conversation app installed, you can copy the key from its `.env` file (same parent directory, under `conversation_venv`).
113
+ - **`OPENCLAW_TOKEN`** — your gateway auth token, found in `~/.openclaw/openclaw.json` under `gateway.auth.token`.
114
+ - **`OPENCLAW_GATEWAY_URL`** — defaults to `ws://localhost:18789` if OpenClaw runs on the same machine.
115
+
116
  That's it — launch ReachyClaw from the app and it will work.
117
 
118
  ### From Source (CLI / development)
 
136
 
137
  ## Configuration
138
 
139
+ Edit `.env` (see `.env.example` for all options):
140
 
141
  ```bash
142
  # Required
 
144
 
145
  # OpenClaw Gateway (required)
146
  OPENCLAW_GATEWAY_URL=ws://localhost:18789
147
+ OPENCLAW_TOKEN=your-gateway-token # from ~/.openclaw/openclaw.json → gateway.auth.token
148
  OPENCLAW_AGENT_ID=main
149
 
150
  # Optional