Commands and flags
Every flag for status, get, and changelog, with short forms and environment variables.
care has three commands. status runs the checks, get fetches a config file, and changelog derives release notes. Bare care is care status with everything on. Every flag also reads from an environment variable, so a flag set once in the environment applies to every run.
A global --cwd sets the directory care operates in and applies to all commands.
status
Runs the configured checks against the current repo and renders their results. Passing no feature flag runs everything. The process exits non-zero when any check fails.
Feature selection
| Flag | Short | Env | Runs |
|---|---|---|---|
--version-control | -vc | CARE_STATUS_VERSION_CONTROL | Git working-tree and upstream-sync state |
--build | -b | CARE_STATUS_BUILD | The compile check |
--lint | -l | CARE_STATUS_LINT | The linter |
--dependencies | -d | CARE_STATUS_DEPENDENCIES | The dependency check |
--runtime | -r | CARE_STATUS_RUNTIME | Declared vs code vs dependency runtime versions |
--docs | -dc | CARE_STATUS_DOCS | Documentation coverage |
--tests | -t | CARE_STATUS_TESTS | The test run |
--benchmarks | -bn | CARE_STATUS_BENCHMARKS | The benchmark run |
--secrets | -s | CARE_STATUS_SECRETS | The secret scan |
--vulnerabilities | -vu | CARE_STATUS_VULNERABILITIES | The vulnerability scan |
--quality | -q | CARE_STATUS_QUALITY | Umbrella for build, lint, dependencies, runtime, and docs |
--security | -se | CARE_STATUS_SECURITY | Umbrella for secrets and vulnerabilities |
Run modes
| Flag | Short | Env | Effect |
|---|---|---|---|
--coverage | -c | CARE_STATUS_COVERAGE | Collect coverage when running tests (implies --tests) |
--race | -ra | CARE_STATUS_RACE | Run tests with -race |
--fix | CARE_STATUS_FIX | Apply auto-fixes before checking | |
--amend | -a | CARE_STATUS_AMEND | Refresh only the working-tree state into the --output file, then exit |
Output
| Flag | Short | Env | Effect |
|---|---|---|---|
--json | -j | CARE_JSON | Emit the report as JSON to stdout |
--output <file> | -o | CARE_OUTPUT | Write the JSON report to a file instead of stdout |
--stdout | -s | CARE_STDOUT | With --output, also render the human report to stdout |
--explain | -x | CARE_EXPLAIN | Show the per-check score breakdown |
--expand-install | -ei | CARE_EXPAND_INSTALL | Expand the per-tool install phase into its own section |
get
Fetches one file from a source into the current repo, applying any placeholder substitutions before the write. See Fetching config files for the source-resolution rules.
| Argument or flag | Short | Env | Meaning |
|---|---|---|---|
<source> | CARE_GET_SOURCE | First positional. A local path, a github or gist URL, or the owner/repo/path shorthand | |
--out <path> | -o | CARE_GET_OUT | Destination relative to cwd. Defaults to the source's filename |
--token <token> | -t | GITHUB_TOKEN | GitHub token for private sources |
-r token=value | -r | CARE_GET_REPLACE | Replace a placeholder. Repeat for more |
--force | CARE_GET_FORCE | Overwrite an existing destination file |
changelog
Derives release notes from conventional commits and, with --write, maintains a Keep a Changelog file. See Changelog for the workflow.
| Argument or flag | Short | Env | Meaning |
|---|---|---|---|
<tag> | CARE_CHANGELOG_TAG | First positional. Range end. Defaults to the CI ref, the latest tag, then HEAD | |
--since <ref> | CARE_CHANGELOG_SINCE | Exclusive start of the range. Defaults to the previous tag | |
--full | CARE_CHANGELOG_FULL | Start from the first commit, ignoring tags. Conflicts with --since | |
--file <path> | -f | CARE_CHANGELOG_FILE | CHANGELOG.md path read for curated notes and written by --write. Defaults to ./CHANGELOG.md |
--write | CARE_CHANGELOG_WRITE | Maintain the CHANGELOG.md instead of printing | |
--release <version> | CARE_CHANGELOG_RELEASE | With --write, stage a section for an upcoming untagged version | |
--remote <url> | CARE_CHANGELOG_REMOTE | Remote URL overriding git-host detection | |
--token <token> | -t | CARE_GIT_HOST_TOKEN | Git-host API token. Falls back to GITHUB_TOKEN or GH_TOKEN |
--plain | CARE_CHANGELOG_PLAIN | Drop links and author attribution |