Skip to content

Commit 17553ae

Browse files
committed
docs(cli): add install instructions and clarify create interactive flow
1 parent 57e5830 commit 17553ae

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,52 @@
33
`hackctl` is the Go CLI for the core hackctl workflow:
44

55
```bash
6+
hackctl create
67
hackctl create --template mern my-app
78
hackctl start
89
hackctl share
910
```
1011

12+
## Install
13+
14+
The hosted installers download the latest GitHub release and verify checksums before installing.
15+
16+
Supported release platforms:
17+
18+
- Windows x64
19+
- macOS Intel
20+
- macOS Apple Silicon
21+
- Linux x64
22+
- Linux ARM64
23+
24+
Windows x64:
25+
26+
```powershell
27+
irm https://hackctl.dev/install.ps1 | iex
28+
```
29+
30+
macOS Intel and Apple Silicon:
31+
32+
```bash
33+
curl -fsSL https://hackctl.dev/install.sh | sh
34+
```
35+
36+
Linux x64 and ARM64:
37+
38+
```bash
39+
curl -fsSL https://hackctl.dev/install.sh | sh
40+
```
41+
42+
Verify:
43+
44+
```bash
45+
hackctl --version
46+
```
47+
1148
## Quickstart
1249

1350
```bash
51+
hackctl create
1452
hackctl create --template mern my-app
1553
cd my-app
1654
hackctl start
@@ -30,12 +68,14 @@ Notes:
3068
Scaffolds a project from an official template.
3169

3270
```bash
71+
hackctl create
3372
hackctl create --template mern my-app
3473
hackctl create -t mern .
3574
```
3675

3776
Current behavior:
3877

78+
- running `hackctl create` with no args opens an interactive prompt for template and path
3979
- supports official templates: `mern`, `pern`, `next-supabase`, `sveltekit-supabase`, `nuxt-supabase`
4080
- requires `git`, `node >= 20`, and `npm >= 10`
4181
- clones from `https://github.com/hackctl-dev/templates.git`

0 commit comments

Comments
 (0)