CLI reference

The CLI manages platform connections, tenants, model profiles, and storage from the command line.

In Docker, the compiled entrypoint is exposed as the reviewphin command:

docker compose run --rm worker reviewphin <resource> <action> [options]

The Docker image registers reviewphin; there is no separate global host installation.

In a local checkout, use pnpm cli:

pnpm cli <resource> <action> [options]

Both invocations accept the same flags. The command examples below show the image command itself. From a host shell with Docker Compose, prefix the example with docker compose run --rm worker; from a local checkout, replace reviewphin with pnpm cli.

Help

Append --help to any command path to show only matching usage entries:

reviewphin --help
reviewphin tenant --help
reviewphin tenant add --help

Help requests exit successfully. Incomplete or unknown commands exit with an error after displaying contextual help. When a recognized command fails, its usage entry is displayed with the error.

---

Tenant commands

Reusable credentials are registered as platform connections before tenants.

platform connection

reviewphin platform connection add \
  --name main-gitlab \
  --platform gitlab \
  --base-url https://gitlab.example.com \
  --api-token glpat-xxxxxxxx

Bot identity is inferred from the token unless explicitly supplied. The update, remove, and describe commands accept --connection <name-or-id>. list and describe redact connection secrets.

Flag	Add required	Description
--name	Yes	Globally unique connection name.
--platform	No	Platform slug. Defaults to gitlab.
--base-url	Yes	Base URL of the GitLab instance.
--api-token	Yes	API token used for GitLab requests.
--bot-user-id	No	Numeric GitLab user ID of the bot. If omitted, it is requested from the GitLab API using the connection token.
--bot-username	No	GitLab username used to match direct mentions. If omitted, it is requested from the GitLab API.

Provider options, including bot identity, can also be changed with platform connection update --connection <name-or-id>.

For GitHub, registration creates an expiring setup link for the GitHub App manifest flow:

reviewphin platform connection add \
  --platform github \
  --name main-github \
  --owner example-org

Set PUBLIC_URL in the worker environment before running this command. See platform connections for the full GitHub lifecycle.

Use --recreate to issue a fresh setup link without deleting the connection or its tenant assignments. Ordinary GitHub connection updates are rejected because registration changes require an explicit recreate.

Removing a GitHub connection

platform connection remove prints provider-specific cleanup instructions and then removes only ReviewPhin’s local connection record. It does not uninstall or delete the generated GitHub App. Before removing the local connection:

1. Remove all ReviewPhin tenants attached to the connection.
2. In the target account, open Settings > GitHub Apps and uninstall the app.
3. In the account that owns the registration, open Settings > Developer settings > GitHub Apps > Advanced and delete the registration.
4. Run:

reviewphin platform connection remove --connection main-github

GitLab connection recreate and removal similarly print reminders to remove obsolete project webhooks and revoke dedicated access tokens manually.

tenant add

Register a new GitLab or GitHub tenant. --platform defaults to gitlab.

reviewphin tenant add \
  --platform gitlab \
  --connection main-gitlab \
  --project-id 123 \
  --webhook-secret replace-me

For GitHub, the assigned connection must have completed App installation:

reviewphin tenant add \
  --platform github \
  --connection main-github \
  --repository example-org/example-repository

During GitHub tenant registration, ReviewPhin scans existing open pull requests and idempotently provisions missing Run Review check runs. A failed scan aborts registration; rerunning the command safely retries the backfill.

Flag	Required	Description
--platform	No	Code review platform slug. Defaults to gitlab; custom slugs require loading their provider with PLATFORM_MODULES.
--connection	Yes	Globally unique connection name or id. It must be ready and match the tenant platform.
--project-id	GitLab	Numeric GitLab project ID.
--webhook-secret	GitLab	Value expected in the X-Gitlab-Token header for this project’s webhooks.
--repository	GitHub	Repository in owner/repo form, resolved through the configured GitHub App installation.
--model-profile	No	Assign a named model profile to this tenant at registration time.
--sqlite-database-path	No	Override the SQLite file path instead of reading SQLITE_DATABASE_PATH from .env.
--storage-provider-module	No	Override the storage adapter module instead of reading STORAGE_PROVIDER_MODULE from .env.

For non-built-in platforms, set PLATFORM_MODULES in the environment before running tenant add; CLI platform registration uses the same comma-separated module list as the server. See custom platform providers.

---

tenant list

Print all registered tenants.

reviewphin tenant list

The JSON output includes each tenant’s id, key, platform, and modelProfileName.

Flag	Required	Description
--sqlite-database-path	No	Override the SQLite path.
--storage-provider-module	No	Override the storage module.

---

tenant set-profile

Assign an existing model profile to a tenant.

reviewphin tenant set-profile \
  --key https://gitlab.example.com::123 \
  --model-profile byok-gpt5.4

Flag	Required	Description
--tenant-id	Yes*	Internal tenant ID (ULID).
--key	Yes*	Stable tenant key printed by tenant list.
--model-profile	Yes	Name of the profile to assign.
--sqlite-database-path	No	Override the SQLite path.
--storage-provider-module	No	Override the storage module.

* Provide either --tenant-id or --key.

---

tenant clear-profile

Remove the model profile assignment from a tenant (falls back to the database default).

reviewphin tenant clear-profile \
  --key https://gitlab.example.com::123

Flag	Required	Description
--tenant-id	Yes*	Internal tenant ID (ULID).
--key	Yes*	Stable tenant key printed by tenant list.
--sqlite-database-path	No	Override the SQLite path.
--storage-provider-module	No	Override the storage module.

* Provide either --tenant-id or --key.

---

tenant remove

Deregister a tenant and clean up its data. Prints a deletion summary (database rows, run-log directories, hydrated workspaces) and asks for confirmation before deleting. Pass --yes to skip confirmation.

reviewphin tenant remove \
  --key https://gitlab.example.com::123 \
  --yes

Flag	Required	Description
--tenant-id	Yes*	Internal tenant ID (ULID).
--key	Yes*	Stable tenant key printed by tenant list.
--sqlite-database-path	No	Override the SQLite path.
--storage-provider-module	No	Override the storage module.
--workspace-root	No	Override the workspace scratch root (default: WORKSPACE_ROOT from .env).
--run-log-dir	No	Override the run-log root (default: RUN_LOG_DIR from .env).
--yes	No	Skip the interactive confirmation prompt.

* Provide either --tenant-id or --key.

---

Model profile commands

Model profiles store LLM provider configuration. When no profiles exist, ReviewPhin uses the Copilot CLI directly. When profiles exist, the effective profile is resolved in this order:

1. /reviewphin-profile <name> directive in the code review description (the merge request description in GitLab today)
2. the tenant’s assigned profile
3. the database default profile
4. plain Copilot CLI fallback

See model profiles for provider-specific examples.

model-profile add

Create or update a named model profile.

# GitHub Copilot with an explicit model
reviewphin model-profile add \
  --name copilot-gpt5.4 \
  --review-model gpt-5.4 \
  --text-generation-model gpt-5.4-mini \
  --default

# BYOK: self-hosted vLLM
reviewphin model-profile add \
  --name byok-llama \
  --base-url http://vllm-host:8000/v1 \
  --provider-type openai \
  --review-model meta-llama/Llama-3.1-8B-Instruct \
  --text-generation-model meta-llama/Llama-3.1-8B-Instruct

# BYOK: Azure OpenAI
reviewphin model-profile add \
  --name azure-gpt5.4 \
  --base-url https://my-resource.openai.azure.com \
  --provider-type azure \
  --auth-token your-azure-key \
  --review-model my-gpt5.4-deployment \
  --text-generation-model my-gpt5.4mini-deployment

Flag	Required	Description
--name	Yes	Stable profile name. Used in --model-profile flags and /reviewphin-profile MR directives.
--base-url	No	BYOK provider base URL. Leave unset for native Copilot CLI profiles.
--provider-type	No	openai, azure, or anthropic. Required when --base-url is set.
--wire-api	No	responses or completions. Defaults to responses for BYOK profiles.
--auth-token	No	API key for the BYOK provider, or an override GitHub PAT for Copilot profiles. Always masked in CLI output.
--review-model	No	Model identifier for review runs. Required when --base-url is set.
--text-generation-model	No	Model for memory coalescing and lightweight generation. Defaults to --review-model when omitted.
--default	No	Mark this profile as the database default.
--clear-base-url	No	Clear the stored base URL. Also clears provider type and wire API; cannot be combined with new values for either.
--clear-provider-type	No	Clear the stored provider type.
--clear-wire-api	No	Clear the stored wire API setting.
--clear-auth-token	No	Clear the stored auth token.
--clear-review-model	No	Clear the stored review model.
--clear-text-generation-model	No	Clear the stored text-generation model.
--sqlite-database-path	No	Override the SQLite path.
--storage-provider-module	No	Override the storage module.

---

model-profile list

Print all model profiles.

reviewphin model-profile list

Flag	Required	Description
--sqlite-database-path	No	Override the SQLite path.
--storage-provider-module	No	Override the storage module.

---

model-profile set-default

Mark an existing profile as the database default.

reviewphin model-profile set-default --name byok-llama

Flag	Required	Description
--name	Yes	Profile name.
--sqlite-database-path	No	Override the SQLite path.
--storage-provider-module	No	Override the storage module.

---

model-profile clear-default

Remove the default flag from all profiles (fallback to Copilot CLI).

reviewphin model-profile clear-default

Flag	Required	Description
--sqlite-database-path	No	Override the SQLite path.
--storage-provider-module	No	Override the storage module.

---

model-profile remove

Delete a named model profile. Fails if a tenant still references this profile.

reviewphin model-profile remove --name byok-llama

Flag	Required	Description
--name	Yes	Profile name to remove.
--sqlite-database-path	No	Override the SQLite path.
--storage-provider-module	No	Override the storage module.

---

Storage commands

storage migrate

Copy all data from one storage adapter to another. Useful for migrating from SQLite to a custom adapter, or between SQLite databases. See storage & migration for guidance.

reviewphin storage migrate \
  --from-storage-provider-module sqlite \
  --from-sqlite-database-path ./data/old.sqlite \
  --to-storage-provider-module @my-org/reviewphin-postgres \
  --to-sqlite-database-path ./data/new.sqlite

source-* is an alias for from-*, and destination-* is an alias for to-*.

Flag	Required	Description
--from-storage-provider-module	Yes	Source adapter module path or package name.
--from-sqlite-database-path	No	Source SQLite path (when the source is the built-in SQLite adapter).
--to-storage-provider-module	Yes	Target adapter module path or package name.
--to-sqlite-database-path	No	Target SQLite path (when the target is the built-in SQLite adapter).

---

Diagnostic commands

mr describe

Print the hydrated code review context for a given code review. Useful for debugging review inputs without triggering a full review. The command accepts the provider-neutral tenant key and code review identifier.

reviewphin mr describe \
  --key https://gitlab.example.com::123 \
  --code-review-id 42 \
  --json

Flag	Required	Description
--tenant-id	Yes*	Internal tenant ID (ULID).
--key	Yes*	Stable tenant key printed by tenant list.
--code-review-id	Yes	Code review ID. For GitLab this is the merge request IID (the !N number).
--merge-request-iid	No	GitLab-compatible alias for --code-review-id.
--current-interaction-job-id	No	Attach a specific interaction job ID to the context.
--trigger-comment-id	No	Simulate a specific trigger comment.
--trigger-comment-action	No	create or update.
--trigger-comment-updated-at	No	ISO timestamp for the simulated trigger.
--trigger-comment-body	No	Body text for the simulated trigger comment.
--json	No	Output raw JSON instead of formatted text.
--sqlite-database-path	No	Override the SQLite path.
--storage-provider-module	No	Override the storage module.

* Provide either --tenant-id or --key.

If you provide --trigger-comment-action, --trigger-comment-updated-at, or --trigger-comment-body, also provide --trigger-comment-id. For --trigger-comment-action update, provide at least one dedupe input: --trigger-comment-updated-at or --trigger-comment-body.

---

metrics sessions

Print aggregated metrics from run-log files: token counts, tool calls, premium request counts, and durations.

reviewphin metrics sessions

Flag	Required	Description
--run-log-dir	No	Override the run-log root (default: RUN_LOG_DIR from .env).