Skip to content

doc: add CLI "format" command #510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 18, 2025
Merged

doc: add CLI "format" command #510

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1389f1a
doc: release 3.0.0-beta.24
ymc9 Nov 18, 2025
b963381
Merge remote-tracking branch 'origin/main' into doc/beta.24
ymc9 Nov 18, 2025
6822a0d
update CLI reference
ymc9 Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions versioned_docs/version-3.x/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,21 @@ Options:
-h, --help display help for command
```

### format

Format a ZModel schema file.

```bash
Usage: zen format [options]

Format a ZModel schema file.

Options:
--schema <file> schema file (with extension .zmodel). Defaults to "zenstack/schema.zmodel" unless
specified in package.json.
-h, --help display help for command
```

## Overriding Default Options

### Default Schema Location
Expand Down