CLI Reference

seal

An extremely fast release management tool.

Usage

Text Only
seal [OPTIONS] <COMMAND>

Commands

seal self: Manage the seal executable
seal validate: Validate project configuration and structure
seal bump: Bump version and create release branch
seal generate: Generate project files
seal help: Display documentation for a command

seal self

Manage the seal executable

Usage

Text Only
seal self [OPTIONS] <COMMAND>

Commands

seal self version: Display seal's version

seal self version

Display seal's version

Usage

Text Only
seal self version [OPTIONS]

Options

--color color-choice

Control the use of color in output.

By default, seal will automatically detect support for colors when writing to a terminal.

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--help, -h

Display the concise help for this command

--no-progress

Hide all progress outputs.

For example, spinners or progress bars.

--output-format output-format

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which seal will write no output to stdout.

--short

Only print the version

--verbose, -v

Use verbose output

seal validate

Validate project configuration and structure

Usage

Text Only
seal validate [OPTIONS] <COMMAND>

Commands

seal validate config: Validate workspace configuration file
seal validate project: Validate full project workspace including members

seal validate config

Validate workspace configuration file

If no config path is provided, discovers seal.toml in the current directory.

Usage

Text Only
seal validate config [OPTIONS]

Options

--color color-choice

Control the use of color in output.

By default, seal will automatically detect support for colors when writing to a terminal.

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config-file config-file

Path to the config file (seal.toml)

--help, -h

Display the concise help for this command

--no-progress

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which seal will write no output to stdout.

--verbose, -v

Use verbose output

seal validate project

Validate full project workspace including members

If no project path is provided, uses the current directory.

Usage

Text Only
seal validate project [OPTIONS]

Options

--color color-choice

Control the use of color in output.

By default, seal will automatically detect support for colors when writing to a terminal.

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--help, -h

Display the concise help for this command

--no-progress

Hide all progress outputs.

For example, spinners or progress bars.

--project, -p project

Path to the project directory

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which seal will write no output to stdout.

--verbose, -v

Use verbose output

seal bump

Bump version and create release branch

Usage

Text Only
seal bump [OPTIONS] <VERSION>

Arguments

VERSION: Version bump to perform (e.g., 'major', 'minor', 'patch', 'alpha', 'major-beta', or '1.2.3')

Options

--color color-choice

Control the use of color in output.

By default, seal will automatically detect support for colors when writing to a terminal.

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--dry-run

Show what would be done without making any changes

--help, -h

Display the concise help for this command

--no-changelog

Skip generating or updating the changelog

--no-progress

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which seal will write no output to stdout.

--verbose, -v

Use verbose output

seal generate

Generate project files

Usage

Text Only
seal generate [OPTIONS] <COMMAND>

Commands

seal generate changelog: Generate changelog
seal generate release: Generate release body JSON from latest changelog section

seal generate changelog

Generate changelog

We look at all releases, and get all PRs from that release. Then add them to the changelog.

We do not include PRs since the latest release.

Usage

Text Only
seal generate changelog [OPTIONS]

Options

--color color-choice

Control the use of color in output.

By default, seal will automatically detect support for colors when writing to a terminal.

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--dry-run

Perform a dry run without modifying files and print the result to stdout

--help, -h

Display the concise help for this command

--max-prs max-prs

Maximum number of PRs to fetch.

Be aware that this can be slow or can fail due to high number of requests if the number is too high.

Note that this does not mean that you will see this number of PRs in the changelog, this just means before filtering, we will fetch this number of PRs.

Defaults to 100.

--no-progress

Hide all progress outputs.

For example, spinners or progress bars.

--overwrite

Overwrite the changelog file if it already exists

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which seal will write no output to stdout.

--verbose, -v

Use verbose output

seal generate release

Generate release body JSON from latest changelog section

Usage

Text Only
seal generate release [OPTIONS]

Options

--color color-choice

Control the use of color in output.

By default, seal will automatically detect support for colors when writing to a terminal.

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--help, -h

Display the concise help for this command

--no-progress

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which seal will write no output to stdout.

--verbose, -v

Use verbose output

seal help

Display documentation for a command

Usage

Text Only
seal help [OPTIONS] [COMMAND]...

Arguments

COMMAND

Options

--color color-choice

Control the use of color in output.

By default, seal will automatically detect support for colors when writing to a terminal.

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--help, -h

Display the concise help for this command

--no-pager

Disable pager when printing help

--no-progress

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which seal will write no output to stdout.

--verbose, -v

Use verbose output