Skip to content

Commit d24e0ca

Browse files
committed
rebrand devbox
1 parent 0654994 commit d24e0ca

40 files changed

+793
-793
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66
[![Go Report Card](https://goreportcard.com/badge/github.com/itzcozi/coderaft)](https://goreportcard.com/report/github.com/itzcozi/coderaft)
77
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
88

9-
coderaft creates isolated development environments, contained in a project's Docker box (container). Each project operates in its own disposable environment, while your code remains neatly organized in a simple, flat folder on the host machine.
9+
coderaft creates isolated development environments, contained in a project's Docker island. Each project operates in its own disposable environment, while your code remains neatly organized in a simple, flat folder on the host machine.
1010

1111
## Features
1212

1313
- **Instant Setup** - Create isolated development environments in seconds
14-
- **Docker-based** - Leverage the power of boxes (containers) for consistent environments
14+
- **Docker-based** - Leverage the power of islands (containers) for consistent environments
1515
- **Clean Organization** - Keep your code organized in simple, flat folders
1616
- **Configurable** - Define your environment with simple JSON configuration
1717
- **Disposable** - Easily destroy and recreate environments as needed
18-
- **Isolated** - Each project runs in its own box, preventing conflicts
18+
- **Isolated** - Each project runs in its own island, preventing conflicts
1919
- **Docker-in-Docker** - Use Docker within your coderaft environments by default
2020
- **Cross-platform** - Supports Linux, macOS, and Windows (primary target: Debian/Ubuntu)
2121
- **Well Tested** - Comprehensive test suite
@@ -26,7 +26,7 @@ coderaft focuses on fast, disposable, Docker-native development environments wit
2626

2727
- Minimal config: a small JSON file, no heavy frameworks
2828
- Clean host workspace: flat folders, no complex mounts
29-
- Reproducible: isolated per-project boxes you can destroy/recreate anytime
29+
- Reproducible: isolated per-project islands you can destroy/recreate anytime
3030
- Docker-in-Docker ready: use Docker inside your environment out of the box
3131
- Cross-platform: runs on Linux, macOS, and Windows wherever Docker is available
3232

@@ -79,7 +79,7 @@ Commit a `coderaft.json` to your repo so teammates can just:
7979
coderaft up
8080
```
8181

82-
Optional: mount your local dotfiles into the box
82+
Optional: mount your local dotfiles into the island
8383

8484
```bash
8585
coderaft up --dotfiles ~/.dotfiles

docs/src/content/docs/docs/cli.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,16 @@ coderaft up [--dotfiles <path>] [--keep-running]
5454
```
5555

5656
**Options:**
57-
- `--dotfiles <path>`: Mount a local dotfiles directory into common locations inside the box
58-
- `--keep-running`: Keep the box running after setup completes (overrides auto-stop-on-idle)
57+
- `--dotfiles <path>`: Mount a local dotfiles directory into common locations inside the Island
58+
- `--keep-running`: Keep the Island running after setup completes (overrides auto-stop-on-idle)
5959

6060
**Behavior:**
6161
- Reads `./coderaft.json`
62-
- Creates/starts a box named `coderaft_<name>` where `<name>` comes from `coderaft.json`'s `name` (or the folder name)
62+
- Creates/starts a Island named `coderaft_<name>` where `<name>` comes from `coderaft.json`'s `name` (or the folder name)
6363
- Applies ports, env, and volumes from configuration
6464
- Runs a system update, then `setup_commands`
6565
- Installs the coderaft wrapper for nice shell UX
66-
- Records package installations you perform inside the box to `coderaft.lock` (apt/pip/npm/yarn/pnpm). On rebuilds, these commands are replayed to reproduce the environment.
66+
- Records package installations you perform inside the Island to `coderaft.lock` (apt/pip/npm/yarn/pnpm). On rebuilds, these commands are replayed to reproduce the environment.
6767
- If global setting `auto_stop_on_exit` is enabled (default), `coderaft up` stops the container right away if it is idle (no exposed ports and only the init process running). Use `--keep-running` to leave it running.
6868
- When `auto_stop_on_exit` is enabled and your `coderaft.json` does not specify a `restart` policy, coderaft uses `--restart no` to prevent the container from auto-restarting after being stopped.
6969

@@ -80,7 +80,7 @@ coderaft up --dotfiles ~/.dotfiles
8080

8181
### `coderaft init`
8282

83-
Create a new coderaft project with its own Docker box (container).
83+
Create a new coderaft project with its own Docker island.
8484

8585
**Syntax:**
8686
```bash
@@ -91,7 +91,7 @@ coderaft init <project> [flags]
9191
- `--force, -f`: Force initialization, overwriting existing project
9292
- `--template, -t <template>`: Initialize from template (python, nodejs, go, web)
9393
- `--generate-config, -g`: Generate coderaft.json configuration file
94-
- `--config-only, -c`: Generate configuration file only (don't create box)
94+
- `--config-only, -c`: Generate configuration file only (don't create Island)
9595

9696
**Examples:**
9797
```bash
@@ -121,7 +121,7 @@ coderaft init webapp --generate-config
121121

122122
### `coderaft shell`
123123

124-
Open an interactive bash shell in the project's box.
124+
Open an interactive bash shell in the project's Island.
125125

126126
**Syntax:**
127127
```bash
@@ -133,23 +133,23 @@ coderaft shell <project> [--keep-running]
133133
# Enter project environment
134134
coderaft shell myproject
135135

136-
# Start stopped box and enter shell
136+
# Start stopped Island and enter shell
137137
coderaft shell python-app
138138
```
139139

140140
**Notes:**
141-
- Automatically starts the box if stopped
141+
- Automatically starts the Island if stopped
142142
- Sets working directory to `/workspace`
143143
- Your project files are available at `/workspace`
144144
- Exit with `exit`, `logout`, or `Ctrl+D`
145-
- By default, the box stops automatically after you exit the shell when global setting `auto_stop_on_exit` is enabled (default)
146-
- Use `--keep-running` to keep the box running after you exit the shell
145+
- By default, the Island stops automatically after you exit the shell when global setting `auto_stop_on_exit` is enabled (default)
146+
- Use `--keep-running` to keep the Island running after you exit the shell
147147

148148
---
149149

150150
### `coderaft run`
151151

152-
Run an arbitrary command inside the project's box.
152+
Run an arbitrary command inside the project's Island.
153153

154154
**Syntax:**
155155
```bash
@@ -174,15 +174,15 @@ coderaft run myproject bash /workspace/setup.sh
174174
**Notes:**
175175
- Commands run in `/workspace` by default
176176
- Use quotes for complex commands with pipes, redirects, etc.
177-
- Box starts automatically if stopped
178-
- By default, the box stops automatically after the command finishes when global setting `auto_stop_on_exit` is enabled (default)
179-
- Use `--keep-running` to keep the box running after the command finishes
177+
- Island starts automatically if stopped
178+
- By default, the Island stops automatically after the command finishes when global setting `auto_stop_on_exit` is enabled (default)
179+
- Use `--keep-running` to keep the Island running after the command finishes
180180

181181
---
182182

183183
### `coderaft stop`
184184

185-
Stop a project's box if it's running.
185+
Stop a project's Island if it's running.
186186

187187
**Syntax:**
188188
```bash
@@ -191,22 +191,22 @@ coderaft stop <project>
191191

192192
**Examples:**
193193
```bash
194-
# Stop a running box
194+
# Stop a running Island
195195
coderaft stop myproject
196196

197-
# Stop another project's box
197+
# Stop another project's Island
198198
coderaft stop webapp
199199
```
200200

201201
**Notes:**
202-
- Safe to run if the box is already stopped (no-op)
202+
- Safe to run if the Island is already stopped (no-op)
203203
- Complements the default auto-stop behavior after `shell` and `run`
204204

205205
---
206206

207207
### `coderaft destroy`
208208

209-
Stop and remove the project's box.
209+
Stop and remove the project's Island.
210210

211211
**Syntax:**
212212
```bash
@@ -227,14 +227,14 @@ coderaft destroy myproject --force
227227

228228
**Notes:**
229229
- Preserves project files in `~/coderaft/<project>/`
230-
- Box can be recreated with `coderaft init`
230+
- Island can be recreated with `coderaft init`
231231
- Use `rm -rf ~/coderaft/<project>/` to remove files
232232

233233
---
234234

235235
### `coderaft list`
236236

237-
Show all managed projects and their box status.
237+
Show all managed projects and their Island status.
238238

239239
**Syntax:**
240240
```bash
@@ -256,7 +256,7 @@ coderaft list --verbose
256256
**Output Format:**
257257
```
258258
CODERAFT PROJECTS
259-
PROJECT BOX STATUS CONFIG WORKSPACE
259+
PROJECT Island STATUS CONFIG WORKSPACE
260260
-------------------- -------------------- --------------- ------------ ------------------------------
261261
myproject coderaft_myproject Up 2 hours coderaft.json /home/user/coderaft/myproject
262262
webapp coderaft_webapp Exited none /home/user/coderaft/webapp
@@ -268,7 +268,7 @@ Total projects: 2
268268

269269
### `coderaft lock`
270270

271-
Generate a comprehensive environment snapshot as `coderaft.lock.json` for a project. This is ideal for sharing/auditing the exact box image, container configuration, and globally installed packages.
271+
Generate a comprehensive environment snapshot as `coderaft.lock.json` for a project. This is ideal for sharing/auditing the exact Island image, container configuration, and globally installed packages.
272272

273273
**Syntax:**
274274
```bash
@@ -279,7 +279,7 @@ coderaft lock <project> [-o, --output <path>]
279279
- `-o, --output <path>`: Write the lock file to a custom path. Defaults to `<workspace>/coderaft.lock.json`.
280280

281281
**Behavior:**
282-
- Ensures the project's box is running (starts it if needed).
282+
- Ensures the project's Island is running (starts it if needed).
283283
- Inspects the container and its image to capture:
284284
- Base image: name, digest (if available), image ID
285285
- Container config: working_dir, user, restart policy, network, ports, volumes, labels, environment, capabilities, resources (cpus/memory)
@@ -309,7 +309,7 @@ coderaft lock myproject -o ./env/coderaft.lock.json
309309
{
310310
"version": 1,
311311
"project": "myproject",
312-
"box_name": "coderaft_myproject",
312+
"island_name": "coderaft_myproject",
313313
"created_at": "2025-09-18T20:41:51Z",
314314
"base_image": {
315315
"name": "ubuntu:22.04",
@@ -359,7 +359,7 @@ coderaft lock myproject -o ./env/coderaft.lock.json
359359

360360
### `coderaft verify`
361361

362-
Validate that the running box matches the `coderaft.lock.json` exactly. Fails fast on any drift.
362+
Validate that the running Island matches the `coderaft.lock.json` exactly. Fails fast on any drift.
363363

364364
**Syntax:**
365365
```bash
@@ -382,7 +382,7 @@ coderaft verify myproject
382382

383383
### `coderaft apply`
384384

385-
Apply the `coderaft.lock.json` to the running box: configure registries and apt sources, then reconcile package sets to match the lock.
385+
Apply the `coderaft.lock.json` to the running Island: configure registries and apt sources, then reconcile package sets to match the lock.
386386

387387
**Syntax:**
388388
```bash
@@ -589,7 +589,7 @@ coderaft cleanup --all --force
589589

590590
### `coderaft maintenance`
591591

592-
Perform maintenance tasks on coderaft projects and boxes.
592+
Perform maintenance tasks on coderaft projects and Islands.
593593

594594
**Syntax:**
595595
```bash
@@ -599,9 +599,9 @@ coderaft maintenance [flags]
599599
**Options:**
600600
- `--status`: Show detailed system status
601601
- `--health-check`: Check health of all projects
602-
- `--update`: Update all boxes
603-
- `--restart`: Restart stopped boxes
604-
- `--rebuild`: Rebuild all boxes
602+
- `--update`: Update all Islands
603+
- `--restart`: Restart stopped Islands
604+
- `--rebuild`: Rebuild all Islands
605605
- `--auto-repair`: Auto-fix common issues
606606
- `--force`: Skip confirmation prompts
607607

@@ -629,9 +629,9 @@ coderaft maintenance --force --rebuild
629629

630630
### `coderaft update`
631631

632-
Pull the latest base image(s) and rebuild environment box(es).
632+
Pull the latest base image(s) and rebuild environment Island(es).
633633

634-
This command replaces boxes to ensure they are based on the newest upstream images, while preserving your workspace files on the host.
634+
This command replaces Islands to ensure they are based on the newest upstream images, while preserving your workspace files on the host.
635635

636636
**Syntax:**
637637
```bash
@@ -641,7 +641,7 @@ coderaft update [project]
641641
**Behavior:**
642642
- When a project is specified, only that environment is updated
643643
- With no project, all registered projects are updated
644-
- Pulls the latest base image, recreates the box with current coderaft.json config, and re-runs setup commands
644+
- Pulls the latest base image, recreates the Island with current coderaft.json config, and re-runs setup commands
645645
- Replays package install commands from `coderaft.lock` to restore your previously installed packages
646646

647647
**Options:**
@@ -657,10 +657,10 @@ coderaft update
657657
```
658658

659659
**Notes:**
660-
- Your files remain in ~/coderaft/<project>/ and are re-mounted into the new box
660+
- Your files remain in ~/coderaft/<project>/ and are re-mounted into the new Island
661661
- If the project has a coderaft.json, its settings (ports, env, volumes, etc.) are applied on rebuild
662-
- System packages inside the box are updated as part of the rebuild
663-
- If the box exists, it will be stopped and replaced; if missing, it will be created
662+
- System packages inside the Island are updated as part of the rebuild
663+
- If the Island exists, it will be stopped and replaced; if missing, it will be created
664664

665665
## Exit Codes
666666

@@ -702,7 +702,7 @@ When you create a project, coderaft sets up:
702702
└── ...
703703
```
704704

705-
**Inside Box:**
705+
**Inside Island:**
706706
```
707707
/workspace/ # Mounted from ~/coderaft/<project>/
708708
├── coderaft.json # Same files as host
@@ -782,14 +782,14 @@ coderaft templates show <TAB> # Shows: available-template-names
782782

783783
---
784784

785-
Coderaft creates boxes (Docker containers) with these characteristics:
785+
Coderaft creates Islands (Docker containers) with these characteristics:
786786

787787
- **Name**: `coderaft_<project>`
788788
- **Base Image**: `ubuntu:22.04` (configurable)
789789
- **Working Directory**: `/workspace`
790790
- **Mount**: `~/coderaft/<project>``/workspace`
791791
- **Restart Policy**: `unless-stopped` (or `no` when `auto_stop_on_exit` is enabled and no explicit policy is set)
792-
- **Command**: `sleep infinity` (keeps box alive)
792+
- **Command**: `sleep infinity` (keeps Island alive)
793793

794794
**Docker Commands Equivalent:**
795795
```bash

docs/src/content/docs/docs/configuration.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,16 @@ Each project can have a `coderaft.json` file in its workspace directory that def
7777
Key fields you may use: `name`, `base_image`, `setup_commands`, `environment`, `ports`, `volumes`, `dotfiles`, `working_dir`. Advanced options like `capabilities`, `labels`, `network`, `restart`, `resources`, and `health_check` are supported but optional.
7878

7979
:::note
80-
Regardless of configuration, coderaft always runs `apt update -y && apt full-upgrade -y` first when initializing any box to ensure the system is up to date. Your `setup_commands` will run after this system update.
80+
Regardless of configuration, coderaft always runs `apt update -y && apt full-upgrade -y` first when initializing any Island to ensure the system is up to date. Your `setup_commands` will run after this system update.
8181
:::
8282

8383
## Reproducible Installs
8484
---
8585

86-
Coderaft automatically records package manager installs you run inside the box to `/workspace/coderaft.lock` (which is your project folder on the host).
86+
Coderaft automatically records package manager installs you run inside the Island to `/workspace/coderaft.lock` (which is your project folder on the host).
8787

8888
Lock file paths:
89-
- Inside box: `/workspace/coderaft.lock`
89+
- Inside Island: `/workspace/coderaft.lock`
9090
- On host: `~/coderaft/<project>/coderaft.lock`
9191

9292
The following commands are tracked when they succeed:
@@ -130,7 +130,7 @@ This writes a JSON snapshot (by default to `<workspace>/coderaft.lock.json`) tha
130130
Usage notes:
131131
- Commit `coderaft.lock.json` to your repository to share environment details with teammates.
132132
- This file is an authoritative snapshot for auditing/sharing. The current execution path for rebuilds remains `coderaft.json` + the simple `coderaft.lock` replay file. You can now also use:
133-
- `coderaft verify <project>` to validate a box matches the lock (fails fast on drift)
133+
- `coderaft verify <project>` to validate a Island matches the lock (fails fast on drift)
134134
- `coderaft apply <project>` to configure registries/sources and reconcile package sets to the lock
135135
- Local app dependencies (e.g. non-global Node packages in your repo) are intentionally not included; rely on your project’s own lockfiles (package-lock.json, yarn.lock, pnpm-lock.yaml, requirements.txt/poetry.lock, etc.).
136136
@@ -163,7 +163,7 @@ This reads `./coderaft.json` and starts the environment without requiring prior
163163
164164
### Dotfile Injection
165165
166-
You can mount your personal dotfiles into the box to keep your editor/shell preferences:
166+
You can mount your personal dotfiles into the Island to keep your editor/shell preferences:
167167
168168
```bash
169169
# One-off via flag
@@ -276,7 +276,7 @@ Global settings are stored in `~/.coderaft/config.json`:
276276
|--------|------|---------|-------------|
277277
| `default_base_image` | string | `ubuntu:22.04` | Default base image for new projects |
278278
| `auto_update` | boolean | `true` | Whether to run updates during initialization |
279-
| `auto_stop_on_exit` | boolean | `true` | If enabled, coderaft stops a project's box automatically after exiting an interactive shell or finishing a one-off `run` command. Override per-invocation with `--keep-running`. |
279+
| `auto_stop_on_exit` | boolean | `true` | If enabled, coderaft stops a project's Island automatically after exiting an interactive shell or finishing a one-off `run` command. Override per-invocation with `--keep-running`. |
280280

281281
When `auto_stop_on_exit` is enabled:
282282
- `coderaft up` will also stop the container if it is idle right after setup (no ports exposed and only the init process running), unless `--keep-running` is passed.
@@ -309,7 +309,7 @@ coderaft init old-project --template nodejs
309309
---
310310

311311
- Invalid JSON in `coderaft.json` will show parsing errors
312-
- Missing required fields are validated before box creation
312+
- Missing required fields are validated before Island creation
313313
- Invalid port/volume formats are caught during validation
314314
- Failed setup commands stop initialization with clear error messages
315315

0 commit comments

Comments
 (0)