a reactive (signals based) hypermedia web framework (wip)
stormlightlabs.github.io/volt/
hypermedia
frontend
signals
1# create-voltx
2
3CLI for creating and managing VoltX.js applications.
4
5## Usage
6
7### Create a New Project
8
9```bash
10# Using pnpm (recommended)
11pnpm create voltx my-app
12
13# Using npm
14npm create voltx@latest my-app
15
16# Using npx
17npx create-voltx my-app
18```
19
20### Commands
21
22#### `init [project-name]`
23
24Create a new VoltX.js project with interactive template selection.
25
26```bash
27voltx init my-app
28```
29
30**Templates:**
31
32- **Minimal** - Basic VoltX.js app with counter
33- **With Router** - Multi-page app with routing
34- **With Plugins** - All plugins demo
35- **Styles Only** - Just HTML + CSS, no framework
36
37#### `dev`
38
39Start Vite development server.
40
41```bash
42voltx dev [--port 3000] [--open]
43```
44
45#### `build`
46
47Build project for production.
48
49```bash
50voltx build [--out dist]
51```
52
53#### `download`
54
55Download VoltX.js assets from CDN.
56
57```bash
58voltx download [--version latest] [--output .]
59```
60
61## Documentation
62
63See the [CLI Guide](https://stormlightlabs.github.io/volt/cli) for complete documentation.
64
65## Development
66
67```bash
68# Install dependencies
69pnpm install
70
71# Build CLI
72pnpm build
73
74# Run tests
75pnpm test
76
77# Type check
78pnpm typecheck
79```
80
81## License
82
83MIT