Synopsis

docent [OPTIONS] <COMMAND>

Options

-h, --help

Print help.

Scope: built-in

-V, --version

Print version.

Scope: built-in

Command reference

docent status

Show project lint plan and effective rules

Print project metadata, lint scan roots, excluded dependencies, and effective rule severities. Always exits 0 after a successful report (use docent to lint and enforce severities).

Parent: docent

Synopsis

docent status [OPTIONS] <paths>...

Arguments

<paths>…​

Files or directories to summarize. If omitted, uses package paths from build.zig.zon when available.

Variadic: accepts multiple values.

Options

--config-path <PATH>

Path to docent.toml

When omitted, Docent searches upward from the working directory for .config/docent.toml.

Scope: local

--deps

Lint local path dependencies from build.zig.zon

Default: false

Scope: local

docent init

Create a default Docent configuration file

Write .config/docent.toml using the selected bundled template and the published JSON Schema URL. Use --preset tiger for Tiger Style or --preset godoc for Go Doc Comments. Does not overwrite an existing file.

Parent: docent

Synopsis

docent init [OPTIONS]

Options

--force

Overwrite an existing configuration file

Default: false

Scope: local

--preset <VALUE>

Choose a bundled configuration preset

Use tiger for Tiger Style naming and a strict 100-column limit, or godoc for Go-style public API documentation.

Default: standard

Possible values: standard, tiger, godoc

Scope: local

docent check

Run Docent lint checks

Run documentation, style, complexity, or size checks. Use a category subcommand for full diagnostics, or run docent check alone for a compact summary across every category.

Parent: docent

Synopsis

docent check [OPTIONS] <COMMAND>

Options

--config-path <FILE>

Path to a docent.toml configuration file

Must point to a file, not a directory. When omitted, Docent searches upward from the working directory for .config/docent.toml.

Scope: local

--manifest-path <PATH>

Path to a build.zig.zon manifest or its parent directory

Operates as if Docent were invoked from the manifest’s directory. Accepts the manifest file directly or a directory containing it. When omitted, searches upward from the working directory.

Scope: local

--deps

Analyze local path dependencies from build.zig.zon (.path entries only, not URL-based)

Default: false

Scope: local

Subcommands

docent check doc

Check documentation comments

Lint doc comments on the public API surface (or all declarations when scan_mode is "all" in config). Exits non-zero when a denied rule reports a finding.

Parent: docent check

Synopsis

docent check doc [OPTIONS] <paths>...

Arguments

<paths>…​

Files or directories to analyze. If omitted, uses package paths from build.zig.zon when available.

Variadic: accepts multiple values.

Options

--config-path <FILE>

Path to a docent.toml configuration file

Must point to a file, not a directory. When omitted, Docent searches upward from the working directory for .config/docent.toml.

Scope: global

--manifest-path <PATH>

Path to a build.zig.zon manifest or its parent directory

Operates as if Docent were invoked from the manifest’s directory. Accepts the manifest file directly or a directory containing it. When omitted, searches upward from the working directory.

Scope: global

--deps

Analyze local path dependencies from build.zig.zon (.path entries only, not URL-based)

Default: false

Scope: global

-f, --format <FORMAT>

Output format

Default: pretty

Possible values: pretty, minimal, json

Scope: local

-F, --fail-fast <WHEN>

Stop after the first matching severity

Default: none

Possible values: none, error, warn, any

Scope: local

docent check style

Check naming-case and style rules

Check identifiers in every selected source file. Severities are set in project config (.config/docent.toml). Exits non-zero when a denied rule reports a finding.

Parent: docent check

Synopsis

docent check style [OPTIONS] <paths>...

Arguments

<paths>…​

Files or directories to analyze. If omitted, uses package paths from build.zig.zon when available.

Variadic: accepts multiple values.

Options

--config-path <FILE>

Path to a docent.toml configuration file

Must point to a file, not a directory. When omitted, Docent searches upward from the working directory for .config/docent.toml.

Scope: global

--manifest-path <PATH>

Path to a build.zig.zon manifest or its parent directory

Operates as if Docent were invoked from the manifest’s directory. Accepts the manifest file directly or a directory containing it. When omitted, searches upward from the working directory.

Scope: global

--deps

Analyze local path dependencies from build.zig.zon (.path entries only, not URL-based)

Default: false

Scope: global

-f, --format <FORMAT>

Output format

Default: pretty

Possible values: pretty, minimal, json

Scope: local

-F, --fail-fast <WHEN>

Stop after the first matching severity

Default: none

Possible values: none, error, warn, any

Scope: local

docent check cogni

Check cognitive complexity

Measure cognitive complexity for every reachable function.

Parent: docent check

Synopsis

docent check cogni [OPTIONS] <paths>...

Arguments

<paths>…​

Files or directories to analyze. If omitted, uses package paths from build.zig.zon when available.

Variadic: accepts multiple values.

Options

--config-path <FILE>

Path to a docent.toml configuration file

Must point to a file, not a directory. When omitted, Docent searches upward from the working directory for .config/docent.toml.

Scope: global

--manifest-path <PATH>

Path to a build.zig.zon manifest or its parent directory

Operates as if Docent were invoked from the manifest’s directory. Accepts the manifest file directly or a directory containing it. When omitted, searches upward from the working directory.

Scope: global

--deps

Analyze local path dependencies from build.zig.zon (.path entries only, not URL-based)

Default: false

Scope: global

-f, --format <FORMAT>

Output format

Default: pretty

Possible values: pretty, minimal, json

Scope: local

-F, --fail-fast <WHEN>

Stop after the first matching severity

Default: none

Possible values: none, error, warn, any

Scope: local

docent check cyclo

Check cyclomatic complexity

Measure cyclomatic complexity for every reachable function.

Parent: docent check

Synopsis

docent check cyclo [OPTIONS] <paths>...

Arguments

<paths>…​

Files or directories to analyze. If omitted, uses package paths from build.zig.zon when available.

Variadic: accepts multiple values.

Options

--config-path <FILE>

Path to a docent.toml configuration file

Must point to a file, not a directory. When omitted, Docent searches upward from the working directory for .config/docent.toml.

Scope: global

--manifest-path <PATH>

Path to a build.zig.zon manifest or its parent directory

Operates as if Docent were invoked from the manifest’s directory. Accepts the manifest file directly or a directory containing it. When omitted, searches upward from the working directory.

Scope: global

--deps

Analyze local path dependencies from build.zig.zon (.path entries only, not URL-based)

Default: false

Scope: global

-f, --format <FORMAT>

Output format

Default: pretty

Possible values: pretty, minimal, json

Scope: local

-F, --fail-fast <WHEN>

Stop after the first matching severity

Default: none

Possible values: none, error, warn, any

Scope: local

docent check size

Check source size limits

Measure source size limits such as line width and function parameter counts in every selected source file. Thresholds are set in project config (.config/docent.toml). Exits non-zero when a denied rule reports a finding.

Parent: docent check

Synopsis

docent check size [OPTIONS] <paths>...

Arguments

<paths>…​

Files or directories to analyze. If omitted, uses package paths from build.zig.zon when available.

Variadic: accepts multiple values.

Options

--config-path <FILE>

Path to a docent.toml configuration file

Must point to a file, not a directory. When omitted, Docent searches upward from the working directory for .config/docent.toml.

Scope: global

--manifest-path <PATH>

Path to a build.zig.zon manifest or its parent directory

Operates as if Docent were invoked from the manifest’s directory. Accepts the manifest file directly or a directory containing it. When omitted, searches upward from the working directory.

Scope: global

--deps

Analyze local path dependencies from build.zig.zon (.path entries only, not URL-based)

Default: false

Scope: global

-f, --format <FORMAT>

Output format

Default: pretty

Possible values: pretty, minimal, json

Scope: local

-F, --fail-fast <WHEN>

Stop after the first matching severity

Default: none

Possible values: none, error, warn, any

Scope: local

docent check all

Run every check category

Run documentation, style, complexity, and size checks in one pass and print all diagnostics. Exits non-zero when a denied rule reports a finding.

Parent: docent check

Synopsis

docent check all [OPTIONS] <paths>...

Arguments

<paths>…​

Files or directories to analyze. If omitted, uses package paths from build.zig.zon when available.

Variadic: accepts multiple values.

Options

--config-path <FILE>

Path to a docent.toml configuration file

Must point to a file, not a directory. When omitted, Docent searches upward from the working directory for .config/docent.toml.

Scope: global

--manifest-path <PATH>

Path to a build.zig.zon manifest or its parent directory

Operates as if Docent were invoked from the manifest’s directory. Accepts the manifest file directly or a directory containing it. When omitted, searches upward from the working directory.

Scope: global

--deps

Analyze local path dependencies from build.zig.zon (.path entries only, not URL-based)

Default: false

Scope: global

-f, --format <FORMAT>

Output format

Default: pretty

Possible values: pretty, minimal, json

Scope: local

-F, --fail-fast <WHEN>

Stop after the first matching severity

Default: none

Possible values: none, error, warn, any

Scope: local

docent fmt

Format Zig source code

Filesystem-based formatter: recursively walks paths and formats every Zig or ZON file. CLI paths override [fmt].include; when neither is set, package paths from the nearest build.zig.zon are used. Non-Zig manifest files and local path dependencies are ignored. CLI --exclude merges with config exclude.

Parent: docent

Synopsis

docent fmt [OPTIONS] <paths>...

Arguments

<paths>…​

Paths to format. Defaults to [fmt].include, then package paths from build.zig.zon.

Variadic: accepts multiple values.

Options

--stdin

Format source from stdin and write the result to stdout

Scope: local

--check

List non-conforming files and exit with an error if the list is non-empty

Scope: local

--fail-fast

Stop after the first non-conforming file

Scope: local

--ast-check

Validate formatted source with Zig’s AST checker

Scope: local

-f, --format <FORMAT>

Output format for --check mode

Default: pretty

Possible values: pretty, minimal

Scope: local

--exclude <PATH>…​

Exclude paths from formatting (merged with [fmt].exclude)

Scope: local

--zon

Treat all input paths as ZON, regardless of file extension.

Scope: local

docent docs

Print AsciiDoc documentation for this CLI to standard output

Parent: docent

Synopsis

docent docs [OPTIONS]

docent completion

Generate shell completion scripts

Prints a completion script for a shell. Without an argument it uses the shell that launched this program, found by walking up the process tree.

Parent: docent

Synopsis

docent completion [OPTIONS] [shell]

Arguments

[shell]

Target shell.

Possible values: bash, zsh, fish, powershell, nushell

Default: the shell running this program

docent help

Print this message or the help of the given subcommand(s)

Parent: docent

Synopsis

docent help [COMMAND]...