> ## Documentation Index
> Fetch the complete documentation index at: https://unkey.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Unkey is two separate products. Compute builds, deploys, and runs apps behind a gateway. API Management issues API keys, enforces rate limits, manages identities and permissions, and reports usage. Say which product a page belongs to; a reader can use either without the other.
> Every Unkey API endpoint is an HTTP POST to https://api.unkey.com/v2/{service}.{procedure} with a root key in the Authorization: Bearer header. Root keys are workspace scoped.
> Error codes have the form err:{system}:{category}:{specific} and each has a page at /errors/{system}/{category}/{specific}.
> The word environment means production or preview in Compute. Rate limiting has four meanings on this site; the glossary lists them.

# unkey api github install-app

> Get the URL that installs the Unkey GitHub App in your workspace.

<Note>
  You need a root key with the permissions listed on this page. Create one in the dashboard under **Settings > Root Keys**. See [Permission reference](/docs/platform/root-keys/permissions-legacy) for every permission.
</Note>

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 <Tooltip tip="Compute apps: deployable services inside a project. Not your applications in general.">apps</Tooltip> with the `--git` flag of [create-app](/docs/compute/cli/apps/create-app) and [update-app](/docs/compute/cli/apps/update-app).

## Usage

```bash theme={"system"}
unkey api github install-app
```

## Flags

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

### Shared flags

Every `unkey api` command accepts these; [CLI output and shared flags](/docs/platform/cli/output-and-flags) describes them in full. This endpoint takes an empty request body, so `--body` accepts only `{}`; anything else is rejected locally.

<ParamField body="--body" type="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](/docs/platform/cli/output-and-flags#send-a-raw-body).
</ParamField>

<ParamField body="--root-key" type="string">
  Root key for the request. Falls back to `UNKEY_ROOT_KEY`, then to the config file written by `unkey auth login`. See [CLI authentication](/docs/platform/cli/authentication).
</ParamField>

<ParamField body="--api-url" type="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.
</ParamField>

<ParamField body="--config" type="string" default="~/.unkey/config.toml">
  Path of the TOML file that `unkey auth login` writes. Falls back to `UNKEY_CONFIG`.
</ParamField>

<ParamField body="--output" type="string">
  Output format. Falls back to `UNKEY_OUTPUT`. Set `json` to print the full response envelope (`meta` and `data`) for piping; any other value prints the request ID followed by `data`.
</ParamField>

## Required permissions

Your root key needs `workspace.*.install_github`.

Without a matching permission the API answers 403 and the CLI prints `Permission denied:` followed by the detail. See [Root key permissions](/docs/platform/root-keys/permissions) for the full catalog.

## Examples

Get the install URL:

```bash theme={"system"}
unkey api github install-app
```

Print only the URL:

```bash theme={"system"}
unkey api github install-app --output=json | jq -r '.data.url'
```

## API endpoint

The command calls [`POST /v2/github.installApp`](/docs/compute/api-reference/github/install-github-app) and prints its response. The endpoint takes no request fields.

## Related

<Columns cols={1}>
  <Card title="Deploy from GitHub" href="/docs/compute/get-started/deploy-from-github">
    Connect a repository and ship the first deployment.
  </Card>
</Columns>