Airbyte is a data integration platform used by data teams to move data from sources into warehouses, lakes, and operational destinations. This CLI gives engineers and agents a read-only terminal surface for inspecting Airbyte workspaces, sources, destinations, connections, sync jobs, connector definitions, users, organizations, permissions, and tags.
It is generated from Airbyte's official Public API specification and works with Airbyte Cloud or a self-managed Airbyte deployment. The default base URL is https://cloud.airbyte.com/api; local self-managed testing can point AIRBYTE_ADMIN_BASE_URL at http://localhost:8000/api.
Most operational commands require an Airbyte API credential. Configure either AIRBYTE_ADMIN_TOKEN for bearer-token auth or AIRBYTE_ADMIN_AUTH_HEADER when your deployment needs a full Authorization header such as Basic ....
Learn more at Airbyte.
Printed by @sdhilip200 (Dhilip Subramanian).
Quick Start
1. Install
See Install above.
2. Verify Setup
airbyte-admin-pp-cli doctor
This checks your configuration.
3. Try Your First Command
airbyte-admin-pp-cli public get-health-check --json
Unique Features
These capabilities aren't available in any other tool for this API.
public list-sources — Lists Airbyte sources, with sibling destination and connection-detail commands for inspecting configured data movement.public list-jobs — Lists sync jobs with connection filters and pagination for troubleshooting recent ELT activity.public list-connector-definitions — Shows available source or destination connector definitions for a workspace or organization.public list-workspaces — Surfaces workspaces, users, organizations, permissions, and tags for Airbyte operational review.sync — Caches Airbyte read endpoints locally for offline search, export, and repeatable agent analysis.
Usage
Run airbyte-admin-pp-cli --help for the full command reference and flag list.
Commands
public
Manage public
airbyte-admin-pp-cli public get-application - Get an Application detailairbyte-admin-pp-cli public get-connection - Get Connection detailsairbyte-admin-pp-cli public get-destination - Get Destination detailsairbyte-admin-pp-cli public get-documentation - Root path, currently returns a redirect to the documentationairbyte-admin-pp-cli public get-health-check - Health Checkairbyte-admin-pp-cli public get-job - Get Job status and detailsairbyte-admin-pp-cli public get-source - Get Source detailsairbyte-admin-pp-cli public get-stream-properties - Get stream propertiesairbyte-admin-pp-cli public list-applications - List Applicationsairbyte-admin-pp-cli public list-connector-definitions - List connector definitionsairbyte-admin-pp-cli public list-destinations - List destinationsairbyte-admin-pp-cli public list-jobs - List Jobsairbyte-admin-pp-cli public list-organizations-for-user - List all organizations for a userairbyte-admin-pp-cli public list-permissions - List permissionsairbyte-admin-pp-cli public list-sources - List sourcesairbyte-admin-pp-cli public list-tags - Lists all tagsairbyte-admin-pp-cli public list-users - Organization Admin user can list all users within the same organization. Also provide filtering on a list of user IDs or/and a list of user emails.airbyte-admin-pp-cli public list-workspaces - List workspacesairbyte-admin-pp-cli public oauth-callback - Redirected to by identity providers after authentication.
Output Formats
# Human-readable table (default in terminal, JSON when piped)
airbyte-admin-pp-cli public list-sources
# JSON for scripting and agents
airbyte-admin-pp-cli public list-sources --json
# Filter to specific fields
airbyte-admin-pp-cli public list-sources --json --select id,name,status
# Dry run — show the request without sending
airbyte-admin-pp-cli public list-sources --dry-run
# Agent mode — JSON + compact + no prompts in one flag
airbyte-admin-pp-cli public list-sources --agent
Agent Usage
This CLI is designed for AI agent consumption:
- Non-interactive - never prompts, every input is a flag
- Pipeable -
--json output to stdout, errors to stderr
- Filterable -
--select id,name returns only fields you need
- Previewable -
--dry-run shows the request without sending
- Read-only by default - this CLI does not create, update, delete, publish, send, or mutate remote resources
- Offline-friendly - sync/search commands can use the local SQLite store when available
- Agent-safe by default - no colors or formatting unless
--human-friendly is set
Exit codes: 0 success, 2 usage error, 3 not found, 5 API error, 7 rate limited, 10 config error.
Health Check
airbyte-admin-pp-cli doctor
Verifies configuration and connectivity to the API.
Configuration
Config file: ~/.config/airbyte-admin-pp-cli/config.toml
Environment variables:
| Variable | Purpose |
|---|
AIRBYTE_ADMIN_BASE_URL | Override the API root. Use http://localhost:8000/api for a local self-managed Airbyte instance. |
AIRBYTE_ADMIN_TOKEN | Bearer token for Airbyte Cloud or a protected self-managed Public API. The CLI adds the Bearer prefix if omitted. |
AIRBYTE_ADMIN_AUTH_HEADER | Full Authorization header, useful for local deployments that require Basic ... or another scheme. |
AIRBYTE_ADMIN_CONFIG | Optional config file path override. |
Config file example:
base_url = "http://localhost:8000/api"
auth_header = "Bearer <token>"
Static request headers can also be configured under headers; per-command header overrides take precedence.
Troubleshooting
Not found errors (exit code 3)
- Check the resource ID is correct
- Run the
list command to see available items
Generated by CLI Printing Press