Installation
The RedPennon CLI scans your codebase for flag references and reports them. It is the engine behind code references and the GitHub Action.
Install
npm install -g @redpennon/cli
This installs two equivalent binaries: rp (short) and redpennon.
rp --version
rp help
Authentication
Commands that talk to the API need an organisation API token (rpa_…), created under Settings → API tokens in the app. See Authentication → Organisation API tokens.
Provide it in priority order:
--api-token rpa_…flag.RP_API_TOKENenvironment variable.- An auth config file resolved from the CLI config directory.
export RP_API_TOKEN=rpa_xxxxxxxxxxxxxxxxxxxxxxxx
rp usages is side-effect-free and can run with --no-api and no token at all; only commands that read or post project data need credentials.
Project and API base URL
| Option | Env | Purpose |
|---|---|---|
--project <key> | RP_PROJECT_KEY | Selects the project to report against. |
--api-url <url> | — | Overrides the API base URL (self-hosted / development). |
Common commands
| Command | Description |
|---|---|
rp usages | Scan the working tree and print flag-key references. Never posts. See Usages. |
rp keys | Fetch the project's variable keys (backs --only-unused). |
rp repo init | Scaffold a .redpennon/config.yml. |
rp status | Show resolved auth, project, and API URL. |
rp autocomplete | Set up shell completion. |