Skip to main content
The github command group connects a Pipecat Cloud organization to GitHub by installing the Pipecat Cloud GitHub App. Once connected, agents can be built from a repository instead of an image — see agent link and deploy --repo. The connection is per organization, not per agent. One installation covers every agent in the organization.

Deploy from GitHub

The full walkthrough, from connecting an account to deploying on push

​
connect

Install the Pipecat Cloud GitHub App on a GitHub account and link it to your organization, or link an installation that’s already on GitHub. Usage:
Options:
​
string
Organization to connect. If not provided, uses the current organization from your configuration.
​
boolean
default:"false"
Link an installation already on GitHub instead of installing the App: one you installed or had an owner approve, while still a member of the GitHub organization it is on, or one on your personal account or a GitHub organization you own. Requires pipecatcloud 1.4.0 or later.
The command opens the GitHub App install page in your browser and then waits until the organization is connected — there is nothing to copy back into the terminal. After the install, GitHub returns you to the Pipecat Cloud dashboard, where you authorize the App on GitHub and the link completes. If the dashboard asks you to sign in, sign in as the same Pipecat Cloud user the CLI is logged in as. If it shows an error, press Ctrl+C and follow what it says. With --existing, the command opens GitHub’s authorization page instead, and you confirm the installation to link on the dashboard. Use it when an owner approved your request to install the App, when the App was installed from GitHub directly, or to reconnect after github disconnect. See Link an existing installation for who can link one. If you can’t install the App on the GitHub account, GitHub sends an owner a request instead, and the dashboard shows Request sent. Press Ctrl+C; once they approve it, run github connect --existing. If the browser can’t be opened, the URL is printed for you to open manually. The command gives up after 26 minutes, or 14 with --existing; if you finished in the browser after that, github status will show it. It stops waiting sooner, and prints the error, if Pipecat Cloud refuses the CLI’s sign-in or its access to the organization. Connecting an organization that’s already connected is not an error — the command reports the existing installation and leaves it alone. To connect a different GitHub account, run github disconnect first.

​
status

Show the organization’s GitHub connection. Usage:
Options:
​
string
Organization to inspect. If not provided, uses the current organization from your configuration.
Reports the connected GitHub account and type, the installation ID, whether the App is active or suspended, and a link to manage it on GitHub. If the organization isn’t connected, it says so and points at github connect, or github connect --existing for an installation already on GitHub.
A suspended installation stops deploys. status flags it; reinstate the App from GitHub to resume.

​
disconnect

Disconnect the organization from GitHub. Usage:
Options:
​
string
Organization to disconnect. If not provided, uses the current organization from your configuration.
​
boolean
default:"false"
Skip the confirmation prompt.
Pipecat Cloud stops using the installation and removes every repository link in the organization, so linked agents stop auto-deploying. What is already running is not touched. The App itself stays installed on GitHub. Uninstall it there to revoke access entirely, or reconnect it later with github connect --existing.

​
repos

List the repositories the GitHub App can access. Usage:
Options:
​
string
Organization to list repositories for. If not provided, uses the current organization from your configuration.
Shows each repository’s full name, default branch, and visibility. The list reflects what you granted the App on GitHub — if a repository is missing, widen the App’s repository access from GitHub rather than from here.

​
branches

List branches for a repository. Usage:
Arguments:
​
string
required
Repository as owner/repo. Any other form is rejected before the request is made.
Options:
​
string
Prefix to search for. Runs a server-side search, which reaches branches past the plain list’s cap — use it on repositories with many branches.
​
string
Organization to list branches for. If not provided, uses the current organization from your configuration.

​
More Information

Link an agent

Point an existing agent at a repository and branch

Create from a repository

deploy --repo builds a new agent from GitHub