Skip to main content

install-app

Start installing the Unkey GitHub App for your workspace
1 min read

Start installing the Unkey GitHub App for your workspace. The command returns a GitHub App install URL. Open the URL in a browser to install the app and grant repository access. After installation, GitHub returns to Unkey, which binds the installation to your workspace and opens the workspace settings.

Installation applies to the workspace and takes no parameters. Once installed, link repositories to individual apps with the git field on apps.createApp and apps.updateApp.

Required permissions:

  • workspace.*.install_github

Usage#

Global Flags#

FlagTypeDescription
--root-keystringOverride root key ($UNKEY_ROOT_KEY)
--api-urlstringOverride API base URL (default: https://api.unkey.com)
--configstringPath to config file (default: ~/.unkey/config.toml)
--outputstringOutput format. Use json for raw JSON
--bodystringSend an empty JSON object as the request body. This endpoint takes no parameters.

Examples#