// Documentation

cosmo CLI reference.

Every command and flag for the cosmo developer CLI, verified against packages/cli.

CLI · 10

cosmo schema

Print the machine-checkable JSON Schema of the Signal envelope (protocol major version 1), or the SignalType vocabulary with --types. Useful for wiring non-SDK producers and CI contract checks.

$ cosmo schema --help

Print the Signal envelope JSON Schema (protocol major version 1).

Options
  --types                  List the SignalType vocabulary instead of the schema.
  --output, -o <path>     Write to a file instead of stdout.

Examples

$ cosmo schema | jq '.properties | keys'
$ cosmo schema --types
$ cosmo schema -o signal.schema.json

Have a feature in mind?

The protocol, SDKs, and CLI are still pre-1.0. If something here is missing, ambiguous, or wrong - open an issue and propose a change. Every breaking change is debated in DECISIONS.md first.

Run the quickstart →Re-read the envelope spec