describe

Lists the workspace's resources, or describes a single one when you pass a resource_id. It spans resource types (sources, reconciliations, transforms, and so on), so it's the quickest way to take inventory or find the ID you need before drilling in with a type-specific command.

Narrow the list with --type, --search, or --folder, and page through large workspaces with --limit / --offset. For a source's full schema (its columns) use simetrik source describe instead; to read its rows use simetrik data query.

Requires CLI access to the workspace. See permissions.

Arguments

• resource_id (optional) — Resource ID (omit to list all resources)

Flags

• -t, --type <type> — Filter by resource type
• -s, --search <query> — Search by name
• --folder <id> — Filter by folder ID
• -l, --limit <n> — Max results
• --offset <n> — Offset for pagination
• -f, --format <fmt> — Output format: table|json

Examples

simetrik describe
simetrik describe --type source --search ventas
simetrik describe res_abc123