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
{{ message }}
This repository was archived by the owner on Jun 4, 2026. It is now read-only.
- Fix track.ts file filtering: use `filename !== '.realm.json'` instead of
`!filename.startsWith('.realm.json')`
- Add Windows compatibility check in stop.ts with helpful message
- Improve stop.ts process matching to handle both dev (tsx) and installed
(boxel, node) modes
- Add BOXEL_PASSWORD env var support in profile.ts for secure non-interactive
usage
- Fix touch.ts missing sync() method implementation
- Add profile manager integration to check.ts, create.ts, list.ts, skills.ts,
status.ts (was using old env var approach)
- Update docs to use `npx boxel` as default command pattern
- Add security notes about avoiding `-p` flag for passwords in shell history
- Add Claude Code note at top of README with link to claude.ai/code
- Streamline installation section in README
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: .claude/CLAUDE.md
+22-21Lines changed: 22 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,20 +8,22 @@
8
8
9
9
## How to Run Boxel Commands
10
10
11
-
**IMPORTANT:** In this development repo, the `boxel` CLI is not globally installed. Always run commands using:
11
+
After `npm install && npm run build`, use `npx boxel`:
12
12
13
13
```bash
14
-
npm run dev -- <command> [args]
14
+
npx boxel sync .
15
+
npx boxel history ./workspace
16
+
npx boxel profile add
15
17
```
16
18
17
-
Examples:
19
+
Or use `boxel` directly after `npm link`.
20
+
21
+
**For development** (no rebuild needed after code changes):
18
22
```bash
19
-
npm run dev -- sync .# NOT: boxel sync .
20
-
npm run dev -- history ./workspace # NOT: boxel history ./workspace
21
-
npm run dev -- milestone ./workspace 1 -n "Name"
23
+
npm run dev -- <command>
22
24
```
23
25
24
-
The `--` separates npm arguments from the CLI arguments. All documentation below shows `boxel <command>` for brevity, but always use `npm run dev -- <command>` when executing.
26
+
All documentation below shows `boxel <command>` for brevity.
25
27
26
28
---
27
29
@@ -53,45 +55,44 @@ When you detect a new user (no profile configured), guide them through setup:
53
55
54
56
### Step 1: Check Profile
55
57
```bash
56
-
npm run dev -- profile
58
+
npx boxel profile
57
59
```
58
60
59
61
If no profile exists, run the interactive setup:
60
62
61
63
### Step 2: Add a Profile
62
64
```bash
63
-
npm run dev -- profile add
65
+
npx boxel profile add
64
66
```
65
67
66
68
This launches an interactive wizard that:
67
69
1. Asks for environment (Production or Staging)
68
70
2. Asks for username and password
69
71
3. Creates the profile in `~/.boxel-cli/profiles.json`
70
72
71
-
**Non-interactive option:**
73
+
**Non-interactive option (CI/automation only):**
72
74
```bash
73
-
# Production
74
-
npm run dev -- profile add -u @username:boxel.ai -p "password" -n "My Prod Account"
75
-
76
-
# Staging
77
-
npm run dev -- profile add -u @username:stack.cards -p "password" -n "My Staging Account"
75
+
# Use environment variable to avoid exposing password in shell history
> **Security Note:** Avoid passing passwords via `-p` flag as they appear in shell history and process listings. Use the interactive wizard or `BOXEL_PASSWORD` environment variable.
80
+
80
81
### Step 3: Verify & List Workspaces
81
82
```bash
82
-
npm run dev -- list
83
+
npx boxel list
83
84
```
84
85
85
86
### Step 4: First Sync
86
87
Help them sync their first workspace:
87
88
```bash
88
-
npm run dev -- sync @username/workspace ./workspace-name
Copy file name to clipboardExpand all lines: .claude/commands/setup.md
+54-33Lines changed: 54 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,70 +5,91 @@ Guide new users through Boxel CLI setup.
5
5
## Trigger
6
6
Run this automatically when:
7
7
- User first opens the repo
8
-
- No `.env` file exists
8
+
- No profile is configured (`npx boxel profile` shows nothing)
9
9
- User asks about setup or getting started
10
10
11
11
## Flow
12
12
13
13
### 1. Check Current State
14
14
```bash
15
-
cat .env 2>/dev/null ||echo"NOT_CONFIGURED"
16
-
npm list 2>/dev/null ||echo"NOT_INSTALLED"
15
+
npx boxel profile
17
16
```
18
17
19
-
### 2. Ask Environment Choice
20
-
Present options:
18
+
If no profile exists, proceed with setup.
21
19
22
-
**Production (app.boxel.ai)**
23
-
- For live Boxel usage
24
-
- Your real workspaces
20
+
### 2. Add a Profile
25
21
26
-
**Staging (realms-staging.stack.cards)**
27
-
- For development/testing
28
-
- Experimental features
22
+
**Option A: Interactive (recommended)**
23
+
```bash
24
+
npx boxel profile add
25
+
```
26
+
27
+
This wizard will:
28
+
1. Ask for environment (Production or Staging)
29
+
2. Ask for username and password
30
+
3. Create the profile automatically
29
31
30
-
### 3. Collect Credentials
31
-
Ask for:
32
+
**Option B: Non-interactive (CI/automation)**
33
+
34
+
Ask the user for:
35
+
-**Environment**: Production (app.boxel.ai) or Staging (realms-staging.stack.cards)
32
36
-**Username**: Their Boxel handle (e.g., `aallen90`, `ctse`). Found in Account panel as `@username:stack.cards` or in workspace URLs like `app.boxel.ai/username/workspace-name`
33
37
-**Password**: Same as Boxel web login
34
38
35
-
### 4. Create .env File
39
+
Then run (using environment variable for security):
Copy file name to clipboardExpand all lines: README.md
+51-21Lines changed: 51 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,50 @@
4
4
5
5
Edit Boxel cards locally with your IDE or AI agent, sync changes instantly, and collaborate seamlessly between web UI and local development.
6
6
7
-
### Features
7
+
> **Note:** Boxel CLI is developed and tested with [Claude Code](https://claude.ai/code). For the best experience, install Claude Code first and let it guide you through setup.
> **Security Note:** Avoid passing passwords directly via `-p` flag as they may be exposed in shell history and process listings. Use the interactive wizard or environment variables for credentials.
167
+
138
168
Profiles stored in `~/.boxel-cli/profiles.json`
139
169
140
170
### Option 2: Environment Variables
@@ -486,7 +516,7 @@ npm test # Run tests
486
516
npm run lint # Check code style
487
517
```
488
518
489
-
> **Note:** Use `npm run dev -- <command>` during development. After global install, use `boxel <command>`.
519
+
> **Note:** Use `npm run dev -- <command>` during development (no rebuild needed). After build, use `npx boxel` or `boxel` (after `npm link`).
0 commit comments