Skip to content

Commit 15f9a69

Browse files
committed
Add CLI Quickstart section to README with installation and usage instructions
- Introduced a new section in the README to provide a quickstart guide for the CLI, including installation steps, file and directory validation commands, CI usage examples, and exit code explanations. - This enhancement aims to improve user onboarding and accessibility of CLI functionalities.
1 parent 7e26f2f commit 15f9a69

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,41 @@ Soustack is **computational**—it understands _how_ a recipe behaves.
3737
npm install soustack
3838
```
3939

40+
## CLI Quickstart
41+
42+
### Install
43+
44+
```bash
45+
npm install -g soustack
46+
```
47+
48+
### Validate a file
49+
50+
```bash
51+
soustack validate recipe.soustack.json
52+
```
53+
54+
### Validate a directory or glob
55+
56+
```bash
57+
soustack validate "recipes/**/*.soustack.json"
58+
```
59+
60+
### Use in CI
61+
62+
```yaml
63+
- name: Validate Soustack recipes
64+
run: npx soustack test --strict --json
65+
```
66+
67+
### Exit codes
68+
69+
- `0` = success
70+
- `1` = validation or conformance failure
71+
- `>1` = tool/runtime error
72+
73+
For the full command reference, see docs/cli/README.md.
74+
4075
## What's Included
4176

4277
- **Validation**: `validateRecipe()` validates Soustack JSON against the bundled schema and optional conformance checks.

0 commit comments

Comments
 (0)