|
1 | | -# devbox |
| 1 | +# coderaft |
2 | 2 |
|
3 | 3 | **Isolated development environments for anything** |
4 | 4 |
|
5 | | -[](https://github.com/itzcozi/devbox/actions) |
6 | | -[](https://goreportcard.com/report/github.com/itzcozi/devbox) |
| 5 | +[](https://github.com/itzcozi/coderaft/actions) |
| 6 | +[](https://goreportcard.com/report/github.com/itzcozi/coderaft) |
7 | 7 | [](LICENSE) |
8 | 8 |
|
9 | | -devbox 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 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. |
10 | 10 |
|
11 | 11 | ## Features |
12 | 12 |
|
13 | | -- 🚀 **Instant Setup** - Create isolated development environments in seconds |
14 | | -- 🐳 **Docker-based** - Leverage the power of boxes (containers) for consistent environments |
15 | | -- 📁 **Clean Organization** - Keep your code organized in simple, flat folders |
16 | | -- 🔧 **Configurable** - Define your environment with simple JSON configuration |
17 | | -- 🗑️ **Disposable** - Easily destroy and recreate environments as needed |
18 | | -- 🛡️ **Isolated** - Each project runs in its own box, preventing conflicts |
19 | | -- 🔄 **Docker-in-Docker** - Use Docker within your devbox environments by default |
20 | | -- 🐧 **Linux-only** - Officially supported on Debian/Ubuntu systems |
21 | | -- 🧪 **Well Tested** - Comprehensive test suite on Linux |
| 13 | +- **Instant Setup** - Create isolated development environments in seconds |
| 14 | +- **Docker-based** - Leverage the power of boxes (containers) for consistent environments |
| 15 | +- **Clean Organization** - Keep your code organized in simple, flat folders |
| 16 | +- **Configurable** - Define your environment with simple JSON configuration |
| 17 | +- **Disposable** - Easily destroy and recreate environments as needed |
| 18 | +- **Isolated** - Each project runs in its own box, preventing conflicts |
| 19 | +- **Docker-in-Docker** - Use Docker within your coderaft environments by default |
| 20 | +- **Cross-platform** - Supports Linux, macOS, and Windows (primary target: Debian/Ubuntu) |
| 21 | +- **Well Tested** - Comprehensive test suite |
22 | 22 |
|
23 | | -## Why devbox? |
| 23 | +## Why coderaft? |
24 | 24 |
|
25 | | -devbox focuses on fast, disposable, Docker-native development environments with simple, commit-friendly config. |
| 25 | +coderaft focuses on fast, disposable, Docker-native development environments with simple, commit-friendly config. |
26 | 26 |
|
27 | 27 | - Minimal config: a small JSON file, no heavy frameworks |
28 | 28 | - Clean host workspace: flat folders, no complex mounts |
29 | 29 | - Reproducible: isolated per-project boxes you can destroy/recreate anytime |
30 | 30 | - Docker-in-Docker ready: use Docker inside your environment out of the box |
31 | | -- Designed for Linux/WSL: optimized for Debian/Ubuntu workflows |
| 31 | +- Cross-platform: runs on Linux, macOS, and Windows wherever Docker is available |
32 | 32 |
|
33 | 33 | ## Installation |
34 | 34 |
|
35 | 35 | ```bash |
36 | | -# Mirror (CDN) |
37 | | -curl -fsSL https://devbox.ar0.eu/install.sh | bash |
38 | | - |
39 | 36 | # Using the install script |
40 | | -curl -fsSL https://raw.githubusercontent.com/itzcozi/devbox/main/install.sh | bash |
41 | | - |
42 | | -# Or manually: https://devbox.ar0.eu/docs/install/#manual-build-from-source |
43 | | -``` |
| 37 | +curl -fsSL https://raw.githubusercontent.com/itzcozi/coderaft/main/install.sh | bash |
44 | 38 |
|
45 | | -Notes: |
46 | | -- Some managed shell environments (e.g., AWS CloudShell) may block or challenge CDN traffic, resulting in HTTP 403 when hitting the mirror. Use the primary GitHub Raw URL above in those environments. |
47 | | -- devbox supports Linux environments only (Debian/Ubuntu). On Windows, use WSL2 with an Ubuntu distribution. |
| 39 | +# Mirror (CDN) |
| 40 | +curl -fsSL https://coderaft.ar0.eu/install.sh | bash |
48 | 41 |
|
| 42 | +# Or manually: https://coderaft.ar0.eu/docs/install/#manual-build-from-source |
| 43 | +``` |
49 | 44 |
|
| 45 | +Note: coderaft requires Docker. It supports Linux, macOS, and Windows. On Windows without WSL2, ensure Docker Desktop is running. |
50 | 46 |
|
51 | 47 | ## Quick Start |
52 | 48 |
|
53 | 49 | 1. **Initialize a new project** |
54 | 50 | ```bash |
55 | | - devbox init my-project |
| 51 | + coderaft init my-project |
56 | 52 | ``` |
57 | 53 |
|
58 | 54 | 2. **Enter the development environment** |
59 | 55 | ```bash |
60 | | - devbox shell my-project |
| 56 | + coderaft shell my-project |
61 | 57 | ``` |
62 | 58 |
|
63 | 59 | 3. **Run commands in the environment** |
64 | 60 | ```bash |
65 | | - devbox run my-project "python --version" |
| 61 | + coderaft run my-project "python --version" |
66 | 62 | ``` |
67 | 63 |
|
68 | 64 | 4. **List your environments** |
69 | 65 | ```bash |
70 | | - devbox list |
| 66 | + coderaft list |
71 | 67 | ``` |
72 | 68 |
|
73 | 69 | 5. **Clean up when done** |
74 | 70 | ```bash |
75 | | - devbox destroy my-project |
| 71 | + coderaft destroy my-project |
76 | 72 | ``` |
77 | 73 |
|
78 | 74 | ### Shared configs |
79 | 75 |
|
80 | | -Commit a `devbox.json` to your repo so teammates can just: |
| 76 | +Commit a `coderaft.json` to your repo so teammates can just: |
81 | 77 |
|
82 | 78 | ```bash |
83 | | -devbox up |
| 79 | +coderaft up |
84 | 80 | ``` |
85 | 81 |
|
86 | 82 | Optional: mount your local dotfiles into the box |
87 | 83 |
|
88 | 84 | ```bash |
89 | | -devbox up --dotfiles ~/.dotfiles |
| 85 | +coderaft up --dotfiles ~/.dotfiles |
90 | 86 | ``` |
91 | 87 |
|
92 | 88 | ## Documentation |
93 | 89 |
|
94 | 90 | For detailed documentation, guides, and examples, visit: |
95 | 91 |
|
96 | | -**📖 [devbox.ar0.eu](https://devbox.ar0.eu)** |
| 92 | +**[coderaft.ar0.eu](https://coderaft.ar0.eu)** |
97 | 93 |
|
98 | 94 | ## License |
99 | 95 |
|
|
0 commit comments