Automatic deployments require a GitHub connection. Connect your identity, install the GitHub App on your organization, then link a repository to your project.
The Agentuity GitHub App automates deployments on push, creates preview environments for PRs, and posts build status to GitHub Checks. See Automating Deployments with the GitHub App for the full overview.
Connecting Your GitHub Identity
Authorize Agentuity to access your GitHub account. This opens a browser-based OAuth flow:
agentuity git identity connectThe CLI copies the authorization URL to your clipboard and waits for you to complete the flow in your browser. Press Enter to open the URL automatically.
Check your current connection status:
agentuity git identity status# JSON output
agentuity --json git identity statusRemove your GitHub identity (also removes all installations):
agentuity git identity disconnect
# Skip confirmation prompt
agentuity git identity disconnect --confirmInstalling the GitHub App
After connecting your identity, install the Agentuity GitHub App on organizations or personal accounts to grant repository access.
Install the GitHub App on a new account:
agentuity git account add
# Add to a specific organization
agentuity git account add --org org_abc123This opens a browser flow to select an organization or personal account for the installation. You must have your identity connected first.
List current installations:
agentuity git account list
# JSON output
agentuity --json git account listRemove an installation:
agentuity git account remove
# Remove a specific installation without prompts
agentuity git account remove --account int_xyz --confirm
# Remove from a specific organization
agentuity git account remove --org org_abc123 --account int_xyz --confirmYour identity is your GitHub user account. Installations are per-organization GitHub App installs that grant repository access. You need both: connect your identity first, then add at least one installation.
Linking a Repository
Link your Agentuity project to a GitHub repository for automatic deployments.
agentuity git linkThe CLI detects your current git remote and branch, then walks you through configuration:
- Select a repository (auto-detected from your git remote, or pick from a list)
- Set the root directory (defaults to
., useful for monorepos) - Choose the deployment branch
- Enable/disable auto-deploy on push
- Enable/disable preview deployments on PRs
Non-interactive Linking
# Link to a specific repo without prompts
agentuity git link --repo owner/repo --branch main --confirm
# Monorepo subdirectory
agentuity git link --root packages/my-agent
# Disable auto-deploy
agentuity git link --deploy false
# Enable preview deployments
agentuity git link --preview trueLink Options
| Option | Description |
|---|---|
--repo <owner/repo> | Repository full name |
--branch <branch> | Branch to deploy from (default: repo default branch) |
--root <path> | Root directory containing agentuity.json (default: .) |
--deploy <bool> | Enable auto-deploy on push (default: true) |
--preview <bool> | Enable preview deployments on PRs (default: true) |
--confirm | Skip confirmation prompts |
Browsing Repositories
List all repositories accessible through your installations:
agentuity git list
# Filter by GitHub account
agentuity git list --account my-org
# Filter by organization
agentuity git list --org org_abc123
# JSON output
agentuity --json git listUnlinking
Remove the repository link from your project:
agentuity git unlink
# Skip confirmation
agentuity git unlink --confirmChecking Status
View the full GitHub connection status for your project, including identity, installations, and repository link:
agentuity git status
# JSON output for scripting
agentuity --json git statusThe status output includes:
- Connected GitHub username
- GitHub App installations (organization or personal)
- Linked repository, branch, and directory
- Auto-deploy and preview deployment settings
Next Steps
- Deployment: Configure preview and branch deployments
- Configuration: Set environment variables for linked repos