Skip to content

compozy tool artifact read

Read one workspace-scoped artifact page

For people running agent work2 pages in this section

compozy tool artifact read

Read one workspace-scoped artifact page

compozy tool artifact read <artifact_uri> [flags]

Examples

  # Emit one page as structured JSON
  compozy tool artifact read compozy://tool-artifacts/art_<sha256> --workspace ws-1 -o json

  # Decode page bytes directly to stdout
  compozy tool artifact read compozy://tool-artifacts/art_<sha256> --workspace ws-1 --offset 65536

Options

  -h, --help               help for read
      --limit int          Page size in bytes (default and maximum 65536)
      --offset int         Zero-based byte offset
      --workspace string   Override workspace (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

The root -o, --output flag accepts these values. A renderer is supported only when this command writes that result; jsonl is for commands that emit one JSON record per line.

FormatCommand result
humanInteractive terminal rendering
jsonMachine-readable JSON rendering
jsonlOne JSON record per line when supported
toonCompact agent-readable rendering

Example:

compozy tool artifact read <artifact_uri> -o json

On this page