plexsphere

Appearance

plexctl blueprint ​

Synopsis ​

plexctl blueprint is the read-only operator surface for the Blueprint Catalog. The catalog is curated through a separate management path; this CLI family only exposes the public read operations on /v1/blueprints.

text
plexctl blueprint <subcommand> [flags]

Subcommands ​

plexctl blueprint list ​

GETs /v1/blueprints. Pagination is keyset-based via --cursor / --limit; the --all flag follows next_cursor until exhausted (mutually exclusive with --cursor).

plexctl blueprint get <id> ​

GETs /v1/blueprints/{id}. Local UUID validation rejects malformed id with exit 2 before the wire. The text render includes the embedded versions array and, for each version, the typed parameter_schema rows.

Flags ​

plexctl blueprint list ​

FlagTypeRequiredDescription
--limitintnoMaximum items per page (server default when zero).
--cursorstringnoContinuation token from a previous call.
--allboolnoFollow next_cursor until exhausted. Mutually exclusive with --cursor.

Persistent flags inherited from root ​

--server, --profile, --token-file, --output. See ../plexctl.md.

Exit codes ​

See ../plexctl.md#exit-code-taxonomy.

Examples ​

List all Blueprints across pages ​

shell
plexctl blueprint list \
  --server "${PLEXSPHERE_URL}" \
  --all    \
  --output json

Inspect a single Blueprint ​

shell
plexctl blueprint get 0190a8b8-a0c0-7a0a-8a0a-a0a0a0a0a0b0 \
  --server "${PLEXSPHERE_URL}" \
  --output yaml

Cross-references ​