Skip to content

Commit b587668

Browse files
bricefclaude
andcommitted
Improve Getting Started: show all config methods and Docker workflow
Show three ways to configure the CLI (env vars, config file, flags), explain how to get the key from Docker Compose, and clarify that TUI uses the same config. Make the Docker-to-CLI connection explicit. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent c10f2cb commit b587668

1 file changed

Lines changed: 28 additions & 7 deletions

File tree

README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,28 @@ TASKFLOW_SEED_ADMIN_NAME=admin TASKFLOW_SEED_ADMIN_KEY=my-known-key ./taskflow-s
3535

3636
### 2. Configure the CLI
3737

38+
Set the API key for the CLI (and TUI). All three methods work — use whichever fits your setup:
39+
3840
```bash
41+
# Option A: environment variables (good for quick use)
3942
export TASKFLOW_API_KEY=$(cat seed-admin-key.txt)
40-
# Or add to config file:
41-
# echo "api_key: $(cat seed-admin-key.txt)" >> ~/.config/taskflow/config.yaml
43+
export TASKFLOW_URL=http://localhost:8374 # default, only needed if server is elsewhere
44+
45+
# Option B: config file (persistent)
46+
mkdir -p ~/.config/taskflow
47+
cat > ~/.config/taskflow/config.yaml <<EOF
48+
url: http://localhost:8374
49+
api_key: $(cat seed-admin-key.txt)
50+
EOF
51+
52+
# Option C: flags (one-off commands)
53+
taskflow --url http://localhost:8374 --api-key <key> board list
54+
```
55+
56+
For Docker Compose, the server is on `localhost:8374` by default. Get the key with:
57+
58+
```bash
59+
export TASKFLOW_API_KEY=$(docker compose exec -T taskflow cat /data/seed-admin-key.txt)
4260
```
4361

4462
### 3. Create a board and tasks
@@ -62,16 +80,19 @@ taskflow actor create --name alice --display_name "Alice Chen" --type human --ro
6280
taskflow actor create --name claude --display_name "Claude" --type ai_agent --role member
6381
```
6482

65-
The API key is returned in the response (shown once). Share it with the actor for CLI, TUI, or MCP configuration.
83+
The API key is returned in the response (shown once). Share it with the actor for their CLI, TUI, or MCP configuration.
6684

6785
### 5. Use other interfaces
6886

6987
```bash
70-
# TUI — interactive terminal UI
71-
TASKFLOW_API_KEY=<key> taskflow-tui
88+
# TUI — interactive terminal UI (uses same config as CLI)
89+
taskflow-tui
90+
91+
# TUI — connect to a specific board directly
92+
taskflow-tui platform
7293

73-
# MCP — AI agent integration (see docs/mcp.md)
74-
TASKFLOW_API_KEY=<agent-key> taskflow-mcp
94+
# MCP — AI agent integration (see docs/mcp.md for Claude Code setup)
95+
TASKFLOW_URL=http://localhost:8374 TASKFLOW_API_KEY=<agent-key> taskflow-mcp
7596
```
7697

7798
## Documentation

0 commit comments

Comments
 (0)