Skip to content

Commit 89140f0

Browse files
committed
docs(cli): regenerate from updated help output
1 parent a405401 commit 89140f0

8 files changed

Lines changed: 71 additions & 11 deletions

File tree

docs/cli/check.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,11 @@ Generated from `soustack check --help`. Do not edit manually.
55
```text
66
Usage: soustack check <file> --json
77
8-
Generate JSON conformance report for a recipe file
8+
Generate JSON conformance report for a recipe file.
9+
10+
Options:
11+
--json Output results as JSON
12+
13+
Example:
14+
soustack check recipe.soustack.json --json
915
```

docs/cli/convert.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,13 @@ Generated from `soustack convert --help`. Do not edit manually.
55
```text
66
Usage: soustack convert --from <schemaorg|soustack> --to <schemaorg|soustack> <input> [-o <output>]
77
8-
Convert between Schema.org and Soustack formats
8+
Convert between Schema.org and Soustack formats.
9+
10+
Options:
11+
--from <format> Source format: schemaorg or soustack
12+
--to <format> Target format: schemaorg or soustack
13+
-o, --output <path> Output file path (default: stdout)
14+
15+
Example:
16+
soustack convert --from schemaorg --to soustack recipe.json -o recipe.soustack.json
917
```

docs/cli/import.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,12 @@ Generated from `soustack import --help`. Do not edit manually.
55
```text
66
Usage: soustack import --url <url> [-o <soustack.json>]
77
8-
Import recipe from URL (alias for scrape)
8+
Import recipe from URL (alias for scrape).
9+
10+
Options:
11+
--url <url> URL of the recipe to import
12+
-o, --output <path> Output file path (default: stdout)
13+
14+
Example:
15+
soustack import --url https://example.com/recipe -o recipe.soustack.json
916
```

docs/cli/ingest.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,11 @@ Generated from `soustack ingest --help`. Do not edit manually.
55
```text
66
Usage: soustack ingest <input> [--out <path>]
77
8-
Bulk pipeline for processing multiple recipes (requires @soustack/ingest)
8+
Bulk pipeline for processing multiple recipes (requires @soustack/ingest).
9+
10+
Options:
11+
--out <path> Output directory or file path
12+
13+
Example:
14+
soustack ingest recipes/ --out output/
915
```

docs/cli/scale.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,12 @@ Generated from `soustack scale --help`. Do not edit manually.
55
```text
66
Usage: soustack scale <soustack.json> <multiplier>
77
8-
Scale a recipe by a multiplier
8+
Scale a recipe by a multiplier.
9+
10+
Arguments:
11+
<soustack.json> Path to the recipe file
12+
<multiplier> Scaling factor (e.g., 2 for double, 0.5 for half)
13+
14+
Example:
15+
soustack scale recipe.soustack.json 2
916
```

docs/cli/scrape.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33
Generated from `soustack scrape --help`. Do not edit manually.
44

55
```text
6-
Usage: soustack scrape <url> -o <soustack.json>
6+
Usage: soustack scrape <url> [-o <soustack.json>]
77
8-
Scrape recipe from a URL (canonical URL ingestion)
8+
Scrape recipe from a URL (canonical URL ingestion).
9+
10+
Options:
11+
-o, --output <path> Output file path (default: stdout)
12+
13+
Example:
14+
soustack scrape https://example.com/recipe -o recipe.soustack.json
915
```

docs/cli/test.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,17 @@
33
Generated from `soustack test --help`. Do not edit manually.
44

55
```text
6-
Usage: soustack test [--profile <name>] [--force-profile] [--schema-only] [--strict] [--json]
6+
Usage: soustack test [options]
77
8-
Validate all recipes in the repository
8+
Validate all recipes in the repository.
9+
10+
Options:
11+
--profile <name> Validate against a specific profile
12+
--force-profile Override recipe profile with --profile value
13+
--schema-only Only validate against JSON schema
14+
--strict Treat warnings as errors
15+
--json Output results as JSON
16+
17+
Example:
18+
soustack test --profile base --strict
919
```

docs/cli/validate.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,17 @@
33
Generated from `soustack validate --help`. Do not edit manually.
44

55
```text
6-
Usage: soustack validate <fileOrGlob> [--profile <name>] [--force-profile] [--schema-only] [--strict] [--json]
6+
Usage: soustack validate <fileOrGlob> [options]
77
8-
Validate recipe files against schema and conformance rules
8+
Validate recipe files against schema and conformance rules.
9+
10+
Options:
11+
--profile <name> Validate against a specific profile
12+
--force-profile Override recipe profile with --profile value
13+
--schema-only Only validate against JSON schema
14+
--strict Treat warnings as errors
15+
--json Output results as JSON
16+
17+
Example:
18+
soustack validate "**/*.soustack.json" --profile scalable --strict
919
```

0 commit comments

Comments
 (0)