CLI commands

Read one retained record whole, or in revision-bound UTF-8 fragments.

singularity ecosystem record

singularity ecosystem record KIND ID --state-dir STATE [--offset N] [--bytes N] [--revision SHA256] --json

Without --bytes the record is read whole from --offset (default 0). The result includes kind, id, offset, total_bytes, content_sha256, text and next_offset. To read in fragments, pass --bytes, then each next_offset as --offset with the first fragment's digest as --revision; fragments end at UTF-8 boundaries.

Refusals: record bytes must be at least 1 when given; omit it to read the whole record, continuing a record requires its content_sha256 in revision, record revision must be a lowercase SHA-256 digest, unknown record KIND/ID, an offset past the end, an offset inside a character, and record KIND/ID revision mismatch: requested …, observed …; restart at offset 0 without revision to read its current contents.

Shared control options

--state-dir PATH names the live owner's state directory; its environment equivalent is SINGULARITY_STATE_DIR. It is required: no directory is assumed. --json prints the whole response envelope; without it a successful answer prints only its result, and a refusal prints the whole envelope.

The owner and the client must run as the same Unix user. An owner that is not listening is a refusal — ecosystem owner unavailable at <socket>: <error>; no cached state is presented as live — and every refusal exits nonzero.

Settings