You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Building for Production](#building-for-production)
32
33
-[Testing](#testing)
33
34
-[Linting](#linting)
@@ -101,11 +102,9 @@ In the Discord, you can:
101
102
102
103
### Prerequisites
103
104
104
-
-**Node.js 18+** (tested with Node.js 22)
105
+
-**Node.js 22+** (required: >=22.0.0 <23.0.0)
105
106
-**npm** (comes with Node.js)
106
-
-**Authentication** (choose one):
107
-
-**[Claude Code CLI](https://code.claude.com/docs/en/overview)** (recommended) - Install and authenticate, credentials used automatically
108
-
-**Anthropic API Key** - Direct API key for Claude Agent SDK ([get one here](https://console.anthropic.com/))
107
+
-**[Claude Code CLI](https://code.claude.com/docs/en/overview)** - Install and authenticate with your Anthropic subscription. Automaker integrates with your authenticated Claude Code CLI to access Claude models.
109
108
110
109
### Quick Start
111
110
@@ -117,30 +116,14 @@ cd automaker
117
116
# 2. Install dependencies
118
117
npm install
119
118
120
-
# 3. Build shared packages (can be skipped - npm run dev does it automatically)
121
-
npm run build:packages
122
-
123
-
# 4. Start Automaker
119
+
# 3. Start Automaker
124
120
npm run dev
125
121
# Choose between:
126
122
# 1. Web Application (browser at localhost:3007)
127
123
# 2. Desktop Application (Electron - recommended)
128
124
```
129
125
130
-
**Authentication Setup:** On first run, Automaker will automatically show a setup wizard where you can configure authentication. You can choose to:
131
-
132
-
- Use **Claude Code CLI** (recommended) - Automaker will detect your CLI credentials automatically
133
-
- Enter an **API key** directly in the wizard
134
-
135
-
If you prefer to set up authentication before running (e.g., for headless deployments or CI/CD), you can set it manually:
136
-
137
-
```bash
138
-
# Option A: Environment variable
139
-
export ANTHROPIC_API_KEY="sk-ant-..."
140
-
141
-
# Option B: Create .env file in project root
142
-
echo"ANTHROPIC_API_KEY=sk-ant-..."> .env
143
-
```
126
+
**Authentication:** Automaker integrates with your authenticated Claude Code CLI. Make sure you have [installed and authenticated](https://code.claude.com/docs/en/quickstart) the Claude Code CLI before running Automaker. Your CLI credentials will be detected automatically.
144
127
145
128
**For Development:**`npm run dev` starts the development server with Vite live reload and hot module replacement for fast refresh and instant updates as you make changes.
146
129
@@ -179,6 +162,40 @@ npm run dev:electron:wsl:gpu
179
162
npm run dev:web
180
163
```
181
164
165
+
### Interactive TUI Launcher (Recommended for New Users)
166
+
167
+
For a user-friendly interactive menu, use the built-in TUI launcher script:
Docker provides the most secure way to run Automaker by isolating it from your host filesystem.
@@ -220,16 +256,9 @@ docker-compose logs -f
220
256
docker-compose down
221
257
```
222
258
223
-
##### Configuration
224
-
225
-
Create a `.env` file in the project root if using API key authentication:
226
-
227
-
```bash
228
-
# Optional: Anthropic API key (not needed if using Claude CLI authentication)
229
-
ANTHROPIC_API_KEY=sk-ant-...
230
-
```
259
+
##### Authentication
231
260
232
-
**Note:** Most users authenticate via Claude CLI instead of API keys. See [Claude CLI Authentication](#claude-cli-authentication-optional) below.
261
+
Automaker integrates with your authenticated Claude Code CLI. To use CLI authentication in Docker, mount your Claude CLI config directory (see [Claude CLI Authentication](#claude-cli-authentication) below).
233
262
234
263
##### Working with Projects (Host Directory Access)
235
264
@@ -243,9 +272,9 @@ services:
243
272
- /path/to/your/project:/projects/your-project
244
273
```
245
274
246
-
##### Claude CLI Authentication (Optional)
275
+
##### Claude CLI Authentication
247
276
248
-
To use Claude Code CLI authentication instead of an API key, mount your Claude CLI config directory:
277
+
Mount your Claude CLI config directory to use your authenticated CLI credentials:
249
278
250
279
```yaml
251
280
services:
@@ -343,10 +372,6 @@ npm run lint
343
372
344
373
### Environment Configuration
345
374
346
-
#### Authentication (if not using Claude Code CLI)
347
-
348
-
- `ANTHROPIC_API_KEY`- Your Anthropic API key for Claude Agent SDK (not needed if using Claude Code CLI)
349
-
350
375
#### Optional - Server
351
376
352
377
- `PORT` - Server port (default: 3008)
@@ -357,49 +382,22 @@ npm run lint
357
382
358
383
- `AUTOMAKER_API_KEY`- Optional API authentication for the server
359
384
- `ALLOWED_ROOT_DIRECTORY`- Restrict file operations to specific directory
360
-
- `CORS_ORIGIN` - CORS policy (default: \*)
385
+
- `CORS_ORIGIN`- CORS allowed origins (comma-separated list; defaults to localhost only)
361
386
362
387
#### Optional - Development
363
388
364
389
- `VITE_SKIP_ELECTRON`- Skip Electron in dev mode
365
390
- `OPEN_DEVTOOLS`- Auto-open DevTools in Electron
391
+
- `AUTOMAKER_SKIP_SANDBOX_WARNING`- Skip sandbox warning dialog (useful for dev/CI)
366
392
367
393
### Authentication Setup
368
394
369
-
#### Option 1: Claude Code CLI (Recommended)
395
+
Automaker integrates with your authenticated Claude Code CLI and uses your Anthropic subscription.
370
396
371
397
Install and authenticate the Claude Code CLI following the [official quickstart guide](https://code.claude.com/docs/en/quickstart).
372
398
373
399
Once authenticated, Automaker will automatically detect and use your CLI credentials. No additional configuration needed!
374
400
375
-
#### Option 2: Direct API Key
376
-
377
-
If you prefer not to use the CLI, you can provide an Anthropic API key directly using one of these methods:
378
-
379
-
##### 2a. Shell Configuration
380
-
381
-
Add to your `~/.bashrc` or `~/.zshrc`:
382
-
383
-
```bash
384
-
export ANTHROPIC_API_KEY="sk-ant-..."
385
-
```
386
-
387
-
Then restart your terminal or run `source ~/.bashrc` (or `source ~/.zshrc`).
388
-
389
-
##### 2b. .env File
390
-
391
-
Create a `.env` file in the project root (gitignored):
392
-
393
-
```bash
394
-
ANTHROPIC_API_KEY=sk-ant-...
395
-
PORT=3008
396
-
DATA_DIR=./data
397
-
```
398
-
399
-
##### 2c. In-App Storage
400
-
401
-
The application can store your API key securely in the settings UI. The key is persisted in the `DATA_DIR` directory.
402
-
403
401
## Features
404
402
405
403
### Core Workflow
@@ -508,20 +506,24 @@ Automaker provides several specialized views accessible via the sidebar or keybo
508
506
| **Agent** | `A` | Interactive chat sessions with AI agents for exploratory work and questions |
509
507
| **Spec** | `D` | Project specification editor with AI-powered generation and feature suggestions |
510
508
| **Context** | `C` | Manage context files (markdown, images) that AI agents automatically reference |
511
-
| **Profiles** | `M` | Create and manage AI agent profiles with custom prompts and configurations |
512
509
| **Settings** | `S` | Configure themes, shortcuts, defaults, authentication, and more |
513
510
| **Terminal** | `T` | Integrated terminal with tabs, splits, and persistent sessions |
514
-
| **GitHub Issues** | - | Import and validate GitHub issues, convert to tasks |
0 commit comments