Skip to main content
The github family manages the Gateway’s own GitHub App. Orbit uses the App to read private github.com repositories and to publish task pull requests. The GitHub App reference explains registration, installations, and the short-lived tokens.

​
Commands

Every command accepts --json.

​
orbit github:app:install

Open GitHub in a browser to register the App, install it, or both.
The CLI prints each URL and opens it in a browser when it can. The browser must reach the Gateway’s private HTTPS address, because GitHub redirects to it after registration. On a machine without a browser, open the printed URL on a machine that is on the Orbit VPN. On a Gateway without an App, the command first registers the App. You confirm once on GitHub. The command then opens the App’s install page, where you choose the account or organization and its repositories. The command waits until the Gateway sees the new installation and reports the account. On a Gateway that has an App, the command opens the install page only. Run it once for each account or organization. The install page needs a signed-in GitHub session. GitHub answers it with a 404 for a signed-out browser. The command waits up to ten minutes and asks the Gateway every three seconds. With --json or -n, it prints the URL, does not wait, and reports a status of pending.

​
orbit github:app:show

Show the App name, slug, App ID, owner, GitHub URL, and one row for each installation.
The Gateway lists installations on GitHub for each call, so the result reflects changes made on GitHub. The result never contains the private key.

​
orbit github:app:destroy

Delete the App ID, slug, and private key from the Gateway. Orbit then reads every repository without a credential and cannot publish task pull requests.
The command prints the GitHub page where you delete the App registration. GitHub offers no API for that step.
  • project creates a Project from a repository. The Gateway reads the repository to resolve its default branch.
  • instance clones and deploys Project source on a Node.