Command line interface¶
All commands require a valid configuration in the current working directory.
Manage changelog entries and build changelogs.
usage: rtfc [-h] {check,build,export,new} ...
Positional Arguments¶
- command
Possible choices: check, build, export, new
Sub-commands¶
check¶
Validate the configuration and all changelog entries.
rtfc check [-h]
build¶
Combine the changelog entries into the changelog.
rtfc build [-h] --version VERSION [--dry-run]
Named Arguments¶
- --version
Release version; entry files are deleted after building.
- --dry-run
Print the release notes instead of updating the changelog.
Default:
False
export¶
Print the entries in another format, converted with the configured exporter.
rtfc export [-h] --version VERSION exporter
Positional Arguments¶
- exporter
Id of the configured exporter to use.
Named Arguments¶
- --version
Release version used for the release notes header.
new¶
Create a changelog entry.
rtfc new [-h] [-s {depends on configuration.}] [--meta KEY=VALUE]
[--content CONTENT]
Named Arguments¶
- -s, --section
Possible choices: depends on configuration.
Section id of the entry.
- --meta
Metadata field; can be repeated.
- --content
Entry content; defaults to a placeholder, opened in $EDITOR when set.
Environment variables¶
- EDITOR¶
The editor
rtfc newopens the created entry in, when--contentis not given. When unset, the entry is created with a placeholder content to edit afterwards.