Skip to content

CLI

decode(encoded: str) -> None

Decode a TypeID into its components.

This extracts: - the prefix (if any) - the underlying UUID

This command is primarily intended for inspection and debugging.

encode(uuid: str, prefix: Optional[str] = None) -> None

Encode an existing UUID into a TypeID.

This command is intended for cases where UUIDs already exist (e.g. stored in a database) and need to be represented as TypeIDs.

explain(encoded: str, schema_path: Optional[str], as_json: bool, no_schema: bool, no_links: bool) -> None

Explain a TypeID: parse/validate it, derive facts (uuid, created_at), and optionally enrich explanation from a user-provided schema.

new(prefix: Optional[str] = None) -> None

Generate a new TypeID.

If a prefix is provided, it will be validated and included in the output. If no prefix is provided, a prefix-less TypeID is generated.