workspaces-list
workspaces list
[!NOTE] Requires the
airbyte-agentCLI onPATH. Install viabrew install airbytehq/tap/airbyte-agentor see the project README.
List workspaces in the organization. Workspace names are the identifier passed to almost every connector command, so this is typically the second command in a session (after airbyte-agent enroll).
[!IMPORTANT] Always pass parameters as
--json '{...}'(use--json '{}'for an unfiltered list). Agents should not use per-parameter flags.
[!IMPORTANT] If only one workspace exists, use it directly without prompting the user. Most accounts have a single workspace.
[!NOTE] Pagination is automatic — all workspaces are returned in a single response regardless of server-side page size.
Usage
More from airbytehq/airbyte-agent-cli
schema
Print the merged CLI + OpenAPI schema (request, response, parameters) for any operation.
4workspaces-use
Set the default workspace stored in ~/.airbyte-agent/settings.json. Subsequent commands use this workspace when one isn't explicitly passed.
4connectors-list
List connectors configured in a workspace.
4connectors-delete
Permanently delete a connector from a workspace.
4organizations-list
List organizations the authenticated user belongs to.
4connectors-create
Install a new connector via the secure browser-based credential flow.
4