Skip to main content
Create a root key with the permissions listed on this page under Root Keys in the dashboard sidebar. CLI commands can instead use a session from unkey login with the required permissions. See Permission reference for every permission.
Start installing the Unkey GitHub App for your workspace. The command returns a GitHub install URL. Open it in a browser, install the app, and choose which repositories it can see. GitHub then sends you back to your workspace settings in Unkey. The URL expires 15 minutes after the call (expiresAt, in Unix milliseconds). Run the command again for a new one. Once installed, connect repositories to individual with the --git flag of apps create and apps update.

Usage

Flags

The command has no request-building flags of its own.

Shared flags

Every resource command accepts these; CLI output and shared flags describes them in full. This endpoint takes an empty request body, so --body accepts only {}; anything else is rejected locally.
string
A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See Send a raw body.
string
Root key used for the request. Falls back to UNKEY_ROOT_KEY, then stored credentials, including a CLI session. See CLI authentication for the full precedence order.
string
default:"https://api.unkey.com"
Base URL of the API. Falls back to UNKEY_API_BASE_URL. You don’t normally need to set it.
string
default:"~/.unkey/config.toml"
Path of the TOML config file. Falls back to UNKEY_CONFIG. An explicit --config takes precedence over a stored CLI session. Browser login stores a session, not a root key in this file. See CLI authentication.
enum
default:"human"
Use human (default) for name-first summary tables and single-response trees, or json for the unchanged full response envelope, including all fields and pagination. Trees wrap long values without truncation. Terminal tables use relative timestamps and may shorten display names and descriptions, but never identifiers, slugs, or credentials. Redirected human output keeps complete values and uses RFC3339 UTC timestamps. Falls back to UNKEY_OUTPUT; other values are rejected. --json also selects JSON output. Add --debug to print the request ID to stderr. See Output formats.
boolean
Print the successful response’s request ID to stderr, separate from stdout.
boolean
Print the full response as JSON. Takes precedence over a valid --output or UNKEY_OUTPUT value.

Required permissions

Your root key needs unkey:v1:<workspace_id>:github/apps/*#write. Replace <workspace_id> with the authenticated workspace ID. Without a matching permission the API answers 403 and the CLI prints Permission denied: followed by the detail. See Root key permissions for the full catalog.

Examples

Get the install URL:
Print only the URL:

API endpoint

The command calls POST /v2/github.installApp and prints its response. The endpoint takes no request fields.

Deploy from GitHub

Connect a repository and ship the first deployment.
Last modified on November 11, 2026