{
"name": "communique",
"bin": "communique",
"cmd": {
"full_cmd": [],
"usage": "[FLAGS] <SUBCOMMAND>",
"subcommands": {
"completion": {
"full_cmd": [
"completion"
],
"usage": "completion <SHELL>",
"subcommands": {},
"args": [
{
"name": "SHELL",
"usage": "<SHELL>",
"help": "Shell: bash, zsh, fish, or powershell",
"help_first_line": "Shell: bash, zsh, fish, or powershell",
"required": true,
"double_dash": "Optional",
"hide": false
}
],
"flags": [
{
"name": "help",
"usage": "-h --help",
"help": "Print help",
"help_first_line": "Print help",
"short": [
"h"
],
"long": [
"help"
],
"hide": false,
"global": false,
"action": "help",
"builtin": true
}
],
"mounts": [],
"effect": "read",
"unknown_flags": null,
"hide": false,
"args_override_self": true,
"help": "Generate a self-contained shell completion script",
"name": "completion",
"aliases": [],
"hidden_aliases": [],
"examples": [],
"headings": []
},
"generate": {
"full_cmd": [
"generate"
],
"usage": "generate [FLAGS] <TAG> [PREV_TAG]",
"subcommands": {},
"args": [
{
"name": "TAG",
"usage": "<TAG>",
"help": "Git tag to generate release notes for",
"help_first_line": "Git tag to generate release notes for",
"required": true,
"double_dash": "Optional",
"hide": false
},
{
"name": "PREV_TAG",
"usage": "[PREV_TAG]",
"help": "Previous tag (auto-detected if omitted)",
"help_first_line": "Previous tag (auto-detected if omitted)",
"required": false,
"double_dash": "Optional",
"hide": false
}
],
"flags": [
{
"name": "draft",
"usage": "--draft <DRAFT>",
"help": "Save editable release title, body, changelog, and review as JSON",
"help_first_line": "Save editable release title, body, changelog, and review as JSON",
"short": [],
"long": [
"draft"
],
"hide": false,
"global": false,
"arg": {
"name": "DRAFT",
"usage": "<DRAFT>",
"required": true,
"double_dash": "Optional",
"hide": false
},
"effect": "write"
},
{
"name": "review-report",
"usage": "--review-report <REVIEW_REPORT>",
"help": "Write a Markdown coverage report with sources and omission reasons",
"help_first_line": "Write a Markdown coverage report with sources and omission reasons",
"short": [],
"long": [
"review-report"
],
"hide": false,
"global": false,
"arg": {
"name": "REVIEW_REPORT",
"usage": "<REVIEW_REPORT>",
"required": true,
"double_dash": "Optional",
"hide": false
},
"effect": "write"
},
{
"name": "migration-guide",
"usage": "--migration-guide <MIGRATION_GUIDE>",
"help": "Write an upgrade guide with affected users and before/after examples",
"help_first_line": "Write an upgrade guide with affected users and before/after examples",
"short": [],
"long": [
"migration-guide"
],
"hide": false,
"global": false,
"arg": {
"name": "MIGRATION_GUIDE",
"usage": "<MIGRATION_GUIDE>",
"required": true,
"double_dash": "Optional",
"hide": false
},
"effect": "write"
},
{
"name": "package",
"usage": "--package <PACKAGE>",
"help": "Generate notes for a package configured in communique.toml",
"help_first_line": "Generate notes for a package configured in communique.toml",
"short": [],
"long": [
"package"
],
"hide": false,
"global": false,
"arg": {
"name": "PACKAGE",
"usage": "<PACKAGE>",
"required": true,
"double_dash": "Optional",
"hide": false
}
},
{
"name": "path",
"usage": "--path <PATH>",
"help": "Limit changes to repository-relative paths (repeatable)",
"help_first_line": "Limit changes to repository-relative paths (repeatable)",
"short": [],
"long": [
"path"
],
"var": true,
"hide": false,
"global": false,
"arg": {
"name": "PATH",
"usage": "<PATH>",
"required": true,
"double_dash": "Optional",
"hide": false
}
},
{
"name": "tag-pattern",
"usage": "--tag-pattern <TAG_PATTERN>",
"help": "Only consider baseline tags matching this git glob",
"help_first_line": "Only consider baseline tags matching this git glob",
"short": [],
"long": [
"tag-pattern"
],
"hide": false,
"global": false,
"arg": {
"name": "TAG_PATTERN",
"usage": "<TAG_PATTERN>",
"required": true,
"double_dash": "Optional",
"hide": false
}
},
{
"name": "channel",
"usage": "--channel <CHANNEL>",
"help": "Baseline channel: stable excludes prereleases; all includes them",
"help_first_line": "Baseline channel: stable excludes prereleases; all includes them",
"short": [],
"long": [
"channel"
],
"hide": false,
"global": false,
"arg": {
"name": "CHANNEL",
"usage": "<CHANNEL>",
"required": true,
"double_dash": "Optional",
"hide": false,
"choices": {
"choices": [
"stable",
"all"
]
}
}
},
{
"name": "changelog-path",
"usage": "--changelog-path <CHANGELOG_PATH>",
"help": "Changelog destination relative to the repository root",
"help_first_line": "Changelog destination relative to the repository root",
"short": [],
"long": [
"changelog-path"
],
"hide": false,
"global": false,
"arg": {
"name": "CHANGELOG_PATH",
"usage": "<CHANGELOG_PATH>",
"required": true,
"double_dash": "Optional",
"hide": false
}
},
{
"name": "preserve-sections",
"usage": "--preserve-sections",
"help": "Replace only the communique-marked section of a GitHub release",
"help_first_line": "Replace only the communique-marked section of a GitHub release",
"short": [],
"long": [
"preserve-sections"
],
"hide": false,
"global": false
},
{
"name": "github-release",
"usage": "--github-release",
"help": "Push editorialized notes to the GitHub release",
"help_first_line": "Push editorialized notes to the GitHub release",
"short": [],
"long": [
"github-release"
],
"hide": false,
"global": false,
"conflicts": [
"--draft"
],
"effect": "write"
},
{
"name": "changelog",
"usage": "--changelog",
"help": "Update CHANGELOG.md with the generated changelog entry",
"help_first_line": "Update CHANGELOG.md with the generated changelog entry",
"short": [],
"long": [
"changelog"
],
"hide": false,
"global": false,
"effect": "write"
},
{
"name": "concise",
"usage": "--concise",
"help": "Output concise changelog entry instead of detailed notes",
"help_first_line": "Output concise changelog entry instead of detailed notes",
"short": [],
"long": [
"concise"
],
"hide": false,
"global": false
},
{
"name": "dry-run",
"usage": "-n --dry-run",
"help": "Generate notes without updating GitHub or verifying links",
"help_first_line": "Generate notes without updating GitHub or verifying links",
"short": [
"n"
],
"long": [
"dry-run"
],
"hide": false,
"global": false
},
{
"name": "repo",
"usage": "--repo <REPO>",
"help": "GitHub repo in owner/repo format (auto-detected from git remote)",
"help_first_line": "GitHub repo in owner/repo format (auto-detected from git remote)",
"short": [],
"long": [
"repo"
],
"hide": false,
"global": false,
"arg": {
"name": "REPO",
"usage": "<REPO>",
"required": true,
"double_dash": "Optional",
"hide": false
}
},
{
"name": "model",
"usage": "--model <MODEL>",
"help": "LLM model to use",
"help_first_line": "LLM model to use",
"short": [],
"long": [
"model"
],
"hide": false,
"global": false,
"arg": {
"name": "MODEL",
"usage": "<MODEL>",
"required": true,
"double_dash": "Optional",
"hide": false
}
},
{
"name": "max-tokens",
"usage": "--max-tokens <MAX_TOKENS>",
"help": "Max response tokens",
"help_first_line": "Max response tokens",
"short": [],
"long": [
"max-tokens"
],
"hide": false,
"global": false,
"arg": {
"name": "MAX_TOKENS",
"usage": "<MAX_TOKENS>",
"required": true,
"double_dash": "Optional",
"hide": false
}
},
{
"name": "provider",
"usage": "--provider <PROVIDER>",
"help": "LLM provider (anthropic or openai, auto-detected from model if omitted)",
"help_first_line": "LLM provider (anthropic or openai, auto-detected from model if omitted)",
"short": [],
"long": [
"provider"
],
"hide": false,
"global": false,
"arg": {
"name": "PROVIDER",
"usage": "<PROVIDER>",
"required": true,
"double_dash": "Optional",
"hide": false
}
},
{
"name": "base-url",
"usage": "--base-url <BASE_URL>",
"help": "Base URL for the LLM API",
"help_first_line": "Base URL for the LLM API",
"short": [],
"long": [
"base-url"
],
"hide": false,
"global": false,
"arg": {
"name": "BASE_URL",
"usage": "<BASE_URL>",
"required": true,
"double_dash": "Optional",
"hide": false
}
},
{
"name": "output",
"usage": "-o --output <OUTPUT>",
"help": "Write output to a file instead of stdout",
"help_first_line": "Write output to a file instead of stdout",
"short": [
"o"
],
"long": [
"output"
],
"hide": false,
"global": false,
"arg": {
"name": "OUTPUT",
"usage": "<OUTPUT>",
"required": true,
"double_dash": "Optional",
"hide": false
},
"effect": "write"
},
{
"name": "help",
"usage": "-h --help",
"help": "Print help",
"help_first_line": "Print help",
"short": [
"h"
],
"long": [
"help"
],
"hide": false,
"global": false,
"action": "help",
"builtin": true
}
],
"mounts": [],
"effect": "read",
"unknown_flags": null,
"hide": false,
"args_override_self": true,
"help": "Generate release notes for a git tag",
"name": "generate",
"aliases": [],
"hidden_aliases": [],
"examples": [],
"headings": []
},
"publish": {
"full_cmd": [
"publish"
],
"usage": "publish [--dry-run] <DRAFT>",
"subcommands": {},
"args": [
{
"name": "DRAFT",
"usage": "<DRAFT>",
"help": "JSON artifact written by generate --draft",
"help_first_line": "JSON artifact written by generate --draft",
"required": true,
"double_dash": "Optional",
"hide": false
}
],
"flags": [
{
"name": "dry-run",
"usage": "--dry-run",
"help": "Preview the final release body without writing to GitHub",
"help_first_line": "Preview the final release body without writing to GitHub",
"short": [],
"long": [
"dry-run"
],
"hide": false,
"global": false
},
{
"name": "help",
"usage": "-h --help",
"help": "Print help",
"help_first_line": "Print help",
"short": [
"h"
],
"long": [
"help"
],
"hide": false,
"global": false,
"action": "help",
"builtin": true
}
],
"mounts": [],
"effect": "write",
"unknown_flags": null,
"hide": false,
"args_override_self": true,
"help": "Publish an edited JSON draft without invoking an LLM",
"name": "publish",
"aliases": [],
"hidden_aliases": [],
"examples": [],
"headings": []
},
"init": {
"full_cmd": [
"init"
],
"usage": "init [--force]",
"subcommands": {},
"args": [],
"flags": [
{
"name": "force",
"usage": "--force",
"help": "Overwrite existing config file",
"help_first_line": "Overwrite existing config file",
"short": [],
"long": [
"force"
],
"hide": false,
"global": false,
"effect": "destructive"
},
{
"name": "help",
"usage": "-h --help",
"help": "Print help",
"help_first_line": "Print help",
"short": [
"h"
],
"long": [
"help"
],
"hide": false,
"global": false,
"action": "help",
"builtin": true
}
],
"mounts": [],
"effect": "write",
"unknown_flags": null,
"hide": false,
"args_override_self": true,
"help": "Generate a communique.toml config file in the repo root",
"name": "init",
"aliases": [],
"hidden_aliases": [],
"examples": [],
"headings": []
},
"sponsors": {
"full_cmd": [
"sponsors"
],
"usage": "sponsors",
"subcommands": {},
"args": [],
"flags": [
{
"name": "help",
"usage": "-h --help",
"help": "Print help",
"help_first_line": "Print help",
"short": [
"h"
],
"long": [
"help"
],
"hide": false,
"global": false,
"action": "help",
"builtin": true
}
],
"mounts": [],
"effect": "read",
"unknown_flags": null,
"hide": false,
"args_override_self": true,
"help": "Show the companies sponsoring communique and the jdx.dev open source tools",
"name": "sponsors",
"aliases": [],
"hidden_aliases": [],
"examples": [],
"headings": []
},
"usage": {
"full_cmd": [
"usage"
],
"usage": "usage",
"subcommands": {},
"args": [],
"flags": [
{
"name": "help",
"usage": "-h --help",
"help": "Print help",
"help_first_line": "Print help",
"short": [
"h"
],
"long": [
"help"
],
"hide": false,
"global": false,
"action": "help",
"builtin": true
}
],
"mounts": [],
"effect": "read",
"unknown_flags": null,
"hide": true,
"args_override_self": true,
"help": "Generates a usage spec for the CLI",
"help_long": "Generates a usage spec for the CLI\n\nhttps://usage.jdx.dev",
"name": "usage",
"aliases": [],
"hidden_aliases": [],
"examples": [],
"headings": []
}
},
"args": [],
"flags": [
{
"name": "verbose",
"usage": "-v --verbose",
"help": "Enable verbose logging output",
"help_first_line": "Enable verbose logging output",
"short": [
"v"
],
"long": [
"verbose"
],
"hide": false,
"global": true
},
{
"name": "quiet",
"usage": "-q --quiet",
"help": "Suppress progress output",
"help_first_line": "Suppress progress output",
"short": [
"q"
],
"long": [
"quiet"
],
"hide": false,
"global": true
},
{
"name": "config",
"usage": "-c --config <CONFIG>",
"help": "Path to config file (default: communique.toml in repo root)",
"help_first_line": "Path to config file (default: communique.toml in repo root)",
"short": [
"c"
],
"long": [
"config"
],
"hide": false,
"global": true,
"arg": {
"name": "CONFIG",
"usage": "<CONFIG>",
"required": true,
"double_dash": "Optional",
"hide": false
}
},
{
"name": "help",
"usage": "-h --help",
"help": "Print help",
"help_first_line": "Print help",
"short": [
"h"
],
"long": [
"help"
],
"hide": false,
"global": false,
"action": "help",
"builtin": true
},
{
"name": "version",
"usage": "-V --version",
"help": "Print version",
"help_first_line": "Print version",
"short": [
"V"
],
"long": [
"version"
],
"hide": false,
"global": false,
"action": "version",
"builtin": true
}
],
"mounts": [],
"unknown_flags": null,
"hide": false,
"subcommand_required": true,
"args_override_self": true,
"name": "communique",
"aliases": [],
"hidden_aliases": [],
"examples": [],
"headings": []
},
"config": {
"props": {},
"sources": {},
"files": []
},
"version": "1.4.1",
"usage": "Usage: communique [OPTIONS] <COMMAND>",
"complete": {},
"about": "Editorialized release notes powered by AI",
"min_usage_version": "4.0",
"unknown_flags": "error"
}