Skip to content
Core ConceptsCLI ReferenceAPI Reference
Resource
CompozyOS RuntimeResource

compozy resource list

List desired-state resources

Audience
Operators running durable agent work
Focus
Resource guidance shaped for scanability, day-two clarity, and operator context.

compozy resource list

List desired-state resources

compozy resource list [flags]

Options

  -h, --help                 help for list
      --kind string          Filter by resource kind
      --last int             Maximum number of resources to return
      --owner-id string      Filter by owner id
      --owner-kind string    Filter by owner kind
      --scope-kind string    Filter by scope kind
      --source-id string     Filter by source id
      --source-kind string   Filter by source kind
      --workspace string     Override workspace filter (ID, name, or path)

Options inherited from parent commands

      --json            Emit JSON output
  -o, --output string   Output format: human, json, jsonl, or toon (default "human")

Output Formats

Every Compozy command supports -o, --output:

  • human for interactive terminal use
  • json for scripts and other machine-readable consumers
  • jsonl for wait or streaming commands that emit one JSON record per line
  • toon for compact agent-readable summaries

Example:

compozy resource list -o json

compozy resource get

Show one desired-state resource

compozy resource put

Create or update one desired-state resource

On this page

compozy resource listOptionsOptions inherited from parent commandsOutput Formats