atlanai workspace - Atlan Documentation

Workspace commands are read-only. Create and organize workspaces in the Atlan app; use the CLI to find IDs, hierarchy, roles, and artifact counts.

Commands

list

Lists workspaces visible to the authenticated identity. Usage

atlanai workspace list [flags]

Option	Type	Default	Description
`--query`	string	none	Filter by display name.
`--parent`	string	none	Return direct children of this parent ID.
`--type`	string	none	Filter by `workspace`, `project`, or `folder`.
`--json`	string list	none	Select workspace fields.
`--jq`, `-q`	string	none	Filter JSON output with jq.
`--template`, `-t`	string	none	Render JSON data with a Go template.

get

Gets one workspace by its stable ID. Usage

atlanai workspace get <id> [flags]

The command accepts the same structured-output options as list. Valid JSON fields are artifact_count, artifact_count_by_kind, description, display_name, effective_role, id, kind, parent_id, type, visibility, and workspace_status.

Examples

atlanai workspace list --query platform
atlanai workspace list --parent workspace_123 --type project
atlanai workspace get workspace_123 --json id,display_name,effective_role

Output and behavior

Results include only workspaces visible to the authenticated identity.
list returns a human-readable table unless structured output is requested.
Empty results exit with code 0.