Skip to content

Commit 5fc1730

Browse files
committed
docs(cli): add minimal quickstart and contract notes
1 parent a020d7e commit 5fc1730

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@ hackctl start
88
hackctl share
99
```
1010

11+
## Quickstart
12+
13+
```bash
14+
hackctl create --template mern my-app
15+
cd my-app
16+
hackctl start
17+
hackctl share
18+
```
19+
20+
Notes:
21+
22+
- Run `hackctl start` and `hackctl share` from the project root (where `hackctl.config.json` exists).
23+
- Press `Ctrl+C` to stop `start` services or stop an active `share` tunnel.
24+
- If a required dependency is missing, hackctl prints a short install link.
25+
1126
## Current Commands
1227

1328
### `hackctl create`
@@ -26,7 +41,8 @@ Current behavior:
2641
- clones from `https://github.com/hackctl-dev/templates.git`
2742
- copies the `mern/` subdirectory into the target path
2843
- validates `hackctl.config.json` service and share settings before continuing
29-
- ensures generated `.gitignore` includes `.hackctl/`
44+
- enforces npm-based run commands for official templates
45+
- expects templates to ignore `.hackctl/` in `.gitignore`
3046
- installs Node dependencies for detected services
3147
- fails if the target directory already exists
3248

0 commit comments

Comments
 (0)