88![ Platform] ( https://img.shields.io/badge/Platform-Linux%20|%20macOS%20|%20Windows-lightgrey )
99![ Runtime] ( https://img.shields.io/badge/Runtime-Vix.cpp%201.x-orange )
1010
11- > ** Vix CLI** is the official command-line interface for
11+ > ** Vix CLI** is the official command-line interface for
1212> ** Vix.cpp** — the modern C++ backend runtime.
1313>
1414> It provides a ** professional, modern, runtime-like developer experience**
1515> for C++, comparable to ** Python** , ** Node.js** , ** Deno** , or ** Bun** .
1616
17- ---
18-
1917# 🚀 Overview
2018
2119The Vix CLI (` vix ` ) brings modern runtime ergonomics to C++:
@@ -30,8 +28,6 @@ The Vix CLI (`vix`) brings modern runtime ergonomics to C++:
3028
3129Running ` vix ` with no arguments launches the ** interactive REPL** .
3230
33- ---
34-
3531# ⚙️ Features
3632
3733## 🧠 Built-in REPL (default)
@@ -52,8 +48,6 @@ Explicit mode:
5248vix repl
5349```
5450
55- ---
56-
5751## 🏗️ Project scaffolding
5852
5953``` bash
@@ -66,8 +60,6 @@ Creates:
6660- Modern C++20 structure
6761- Ready-to-run Vix app
6862
69- ---
70-
7163## ⚡ Smart build system
7264
7365``` bash
@@ -79,8 +71,6 @@ vix build
7971- Colored logs & spinners
8072- Clean Ctrl+C handling
8173
82- ---
83-
8474## 🚀 Run applications
8575
8676``` bash
@@ -97,8 +87,6 @@ Script mode:
9787vix run demo.cpp
9888```
9989
100- ---
101-
10290## 🧪 Check & Tests (Sanitizers ready)
10391
10492Compile-only validation:
@@ -124,8 +112,6 @@ vix tests
124112vix tests --san
125113```
126114
127- ---
128-
129115## 📦 Packaging & Verification
130116
131117Create a distribution artifact:
@@ -141,40 +127,57 @@ vix verify dist/blog@1.0.0
141127vix verify dist/blog@1.0.0 --require-signature
142128```
143129
144- ---
145-
146130## 🧠 ErrorHandler — your C++ teacher
147131
148132- Explains template & overload errors
149133- Detects missing includes
150134- Highlights the _ first real error_
151135- Provides actionable hints
152136
153- ---
154-
155137# 🧰 Commands
156138
157139``` bash
158140vix < command> [options]
159141```
160142
161- | Command | Description |
162- | ------------------------- | ---------------------------- |
163- | ` vix ` | Start REPL (default) |
164- | ` vix repl ` | Start REPL explicitly |
165- | ` vix new <name> ` | Create a new project |
166- | ` vix build [name] ` | Configure + build |
167- | ` vix run [name] [--args] ` | Build and run |
168- | ` vix dev [name] ` | Dev mode (watch & reload) |
169- | ` vix check [path] ` | Compile-only validation |
170- | ` vix tests [path] ` | Run tests |
171- | ` vix pack [options] ` | Create distribution artifact |
172- | ` vix verify [options] ` | Verify artifact |
173- | ` vix orm <subcommand> ` | ORM tooling |
174- | ` vix help [command] ` | Show help |
175- | ` vix version ` | Show version |
176-
177- ---
143+ | Command | Description |
144+ | ---------------------------- | --------------------------------------- |
145+ | ` vix ` | Start REPL (default) |
146+ | ` vix repl ` | Start REPL explicitly |
147+ | ` vix new <name> ` | Create a new project |
148+ | ` vix make ` | Generate C++ scaffolding |
149+ | ` vix build [name] ` | Configure + build |
150+ | ` vix run [name] [--args] ` | Build and run |
151+ | ` vix dev [name] ` | Dev mode (watch & reload) |
152+ | ` vix check [path] ` | Compile-only validation |
153+ | ` vix tests [path] ` | Run tests |
154+ | ` vix fmt ` | Format source code |
155+ | ` vix clean ` | Remove project cache |
156+ | ` vix reset ` | Clean and reinstall project |
157+ | ` vix task ` | Run reusable project tasks |
158+ | ` vix add <pkg>@<ver> ` | Add dependency |
159+ | ` vix install ` | Install project dependencies |
160+ | ` vix update ` | Update dependencies |
161+ | ` vix outdated ` | Check available dependency updates |
162+ | ` vix remove <pkg> ` | Remove dependency |
163+ | ` vix list ` | List dependencies |
164+ | ` vix up ` | Alias for ` update ` |
165+ | ` vix i ` | Alias for ` install ` |
166+ | ` vix deps ` | Legacy alias for ` install ` |
167+ | ` vix pack [options] ` | Create distribution artifact |
168+ | ` vix verify [options] ` | Verify artifact |
169+ | ` vix cache ` | Store package locally |
170+ | ` vix registry ` | Sync/search packages |
171+ | ` vix store ` | Manage local cache |
172+ | ` vix orm <subcommand> ` | ORM tooling |
173+ | ` vix p2p ` | Run P2P node |
174+ | ` vix info ` | Show Vix paths and cache locations |
175+ | ` vix doctor ` | Check environment |
176+ | ` vix upgrade ` | Update Vix |
177+ | ` vix uninstall ` | Remove Vix |
178+ | ` vix help [command] ` | Show help |
179+ | ` vix completion ` | Generate shell completion script |
180+ | ` vix version ` | Show version |
178181
179182# 🧪 Usage Examples
180183
@@ -189,8 +192,6 @@ vix pack --name api --version 1.0.0
189192vix verify dist/api@1.0.0
190193```
191194
192- ---
193-
194195# 🧩 Architecture
195196
196197The CLI is built around a command dispatcher:
@@ -211,8 +212,6 @@ std::unordered_map<std::string, CommandHandler> commands;
211212| ` src/commands/PackCommand.cpp ` | Packaging |
212213| ` src/commands/VerifyCommand.cpp ` | Verification |
213214
214- ---
215-
216215# 🔧 Build & Installation
217216
218217### Standalone CLI build
@@ -230,8 +229,6 @@ Binary:
230229./build/vix
231230```
232231
233- ---
234-
235232### Full Vix build
236233
237234``` bash
@@ -240,8 +237,6 @@ cmake -B build -S .
240237cmake --build build
241238```
242239
243- ---
244-
245240# ⚙️ Configuration
246241
247242### Environment variables
@@ -253,52 +248,95 @@ cmake --build build
253248| ` VIX_MINISIGN_SECKEY ` | Secret key for ` pack ` |
254249| ` VIX_MINISIGN_PUBKEY ` | Public key for ` verify ` |
255250
256- ---
257-
258251# 📦 CLI Help Output
259252
260- ``` sql
261- Vix .cpp — Modern C++ backend runtime
262- Version: v1 .x .x
263-
264- Usage:
265- vix [GLOBAL OPTIONS] < COMMAND> [ARGS...]
266- vix help < command>
267-
268- Quick start:
269- vix new api
270- cd api && vix dev
271- vix pack -- name api --version 1.0.0 && vix verify
272-
273- Commands:
274- Project:
275- new < name> Create a new Vix project
276- build [name] Configure + build
277- run [name] Build and run
278- dev [name] Dev mode
279- check [path ] Compile- only validation
280- tests [path ] Run tests
281-
282- Packaging & security:
283- pack Create distribution artifact
284- verify Verify artifact or package
285-
286- REPL:
287- repl Start interactive REPL
288- (default) Run ` vix` to start the REPL
289-
290- Global options:
291- -- verbose
292- - q, -- quiet
293- -- log-level <level>
294- - h, -- help
295- - v, -- version
296-
297253```
298-
299- ---
254+ Vix.cpp
255+ Fast. Simple. Built for real apps.
256+ Version: v2.1.2-dirty
257+
258+ Start in seconds:
259+ vix new api
260+ cd api
261+ vix install
262+ vix dev
263+
264+ Core workflow:
265+ add Add a dependency
266+ install Install project dependencies
267+ update Update dependencies
268+ run Run your app
269+ deploy Deploy your app (coming soon)
270+
271+ Commands:
272+
273+ Project:
274+ Docs: https://vixcpp.com/docs/modules/cli/new
275+ new <name> Create a new project
276+ make Generate C++ scaffolding
277+ dev Start dev server (hot reload)
278+ run Build and run
279+ build Build project
280+ check Validate build or file
281+ tests Run tests
282+ fmt Format source code
283+ clean Remove project cache
284+ reset Clean and reinstall project
285+ task Run reusable project tasks
286+ repl Interactive REPL
287+
288+ Dependencies:
289+ Docs: https://vixcpp.com/docs/modules/cli/search
290+ add <pkg>@<ver> Add dependency
291+ install Install dependencies
292+ update Update dependencies
293+ outdated Check available dependency updates
294+ remove <pkg> Remove dependency
295+ list List dependencies
296+
297+ Aliases:
298+ up Alias for update
299+ i Alias for install
300+ deps Legacy alias for install
301+
302+ Build & share:
303+ Docs: https://vixcpp.com/docs/modules/cli/pack
304+ pack Build distributable package
305+ verify Verify package integrity
306+ cache Store package locally
307+
308+ Advanced:
309+ registry Sync/search packages
310+ store Manage local cache
311+ orm Database migrations
312+ p2p Run P2P node
313+
314+ System:
315+ info Show Vix paths and cache locations
316+ doctor Check environment
317+ upgrade Update Vix
318+ uninstall Remove Vix
319+
320+ Help:
321+ help [command] Show command help
322+ completion Generate shell completion script
323+ version Show version
324+
325+ Global options:
326+ --verbose Debug logs
327+ -q, --quiet Only warnings/errors
328+ --log-level trace|debug|info|warn|error|critical
329+ -h, --help Show help
330+ -v, --version Show version
331+
332+ Docs: https://vixcpp.com/docs
333+ Registry: https://vixcpp.com/registry
334+ GitHub: https://github.com/vixcpp/vix
335+
336+ ~$
337+ ```
300338
301339# 🧾 License
302340
303- ** MIT License** © [ Gaspard Kirira] ( https://github.com/gkirira )
341+ ** MIT License** © [ Gaspard Kirira] ( https://github.com/gkirira )
304342See [ ` LICENSE ` ] ( ../../LICENSE ) for details.
0 commit comments