CLI Commands

shipi generate

Generate release notes from git commits.

shipi generate [range] [options]

Arguments

Argument	Description
`range`	Git revision range (e.g., `v1.0.0..v1.1.0`)

Options

Option	Alias	Description	Default
`--from <ref>`	`-f`	Start commit/tag	Last tag
`--to <ref>`	`-t`	End commit/tag	`HEAD`
`--audience <type>`	`-a`	Output audience	`changelog`
`--format <type>`		Output format	`markdown`
`--output <file>`	`-o`	Write to file	stdout
`--diff`	`-d`	Include diff analysis	`false`
`--tickets`		Extract ticket references	`false`
`--ticket-prefix <list>`		Filter by ticket prefix	all
`--dry-run`		Preview commits only	`false`

Examples

# Generate from last tag to HEAD
shipi generate

# Generate for specific range
shipi generate v1.0.0..v1.1.0

# Generate with options
shipi generate --from v1.0.0 --audience internal --diff

# Output to file
shipi generate -o CHANGELOG.md

Authenticate with shipi.

shipi login

Opens browser for authentication and stores the API key locally.

shipi logout

Remove stored credentials.

shipi logout

shipi config

View or set configuration.

shipi config [key] [value]

Examples

# View all config
shipi config

# View specific key
shipi config audience

# Set value
shipi config audience internal

shipi whoami

Display current user info.

shipi whoami

Global options

These options work with all commands:

Option	Description
`--help`	Show help
`--version`	Show version
`--debug`	Enable debug output