Command Line Interface (CLI)

TimeSeed includes a comprehensive command-line interface (CLI) to generate, decode, and benchmark IDs, as well as checking local system configurations.

Global Options

• --machine-id (int): Set or override the machine ID.
• --datacenter-id (int): Set or override the datacenter ID.
• --preset (str): Choose preset config (high-throughput, long-lifespan, many-datacenters, small-scale).
• --timestamp-bits, --machine-bits, --datacenter-bits, --sequence-bits (int): Configure custom bit space allocation directly.

CLI Subcommands

timeseed generate

Generates one or more unique identifiers.

• Options:
  • -n, --number (int): Number of IDs to generate. Default is 1.
  • -f, --format (str): Output formatting format (integer, hex, base62, base32, binary). Default is integer.
  • -o, --output (str): Path to an output text file to write the IDs instead of standard output.
• Example:
  timeseed generate -n 10 --format base62

timeseed decode

Decodes any generated TimeSeed ID to inspect its internal components.

• Arguments:
  • id_values (str): Space-separated list of IDs to decode.
• Options:
  • --input-format (str): Manually declare the input format (integer, hex, base62, base32, binary). Auto-detects format if not provided.
  • --output-format (str): Output structure type (text, json). Default is text.
• Example:
  timeseed decode 2jk3Nm5pQ8rS1tU7vW9xYz --output-format json

timeseed benchmark

Runs high-throughput performance benchmarking scenarios to test generation speed.

• Options:
  • -d, --duration (int): Duration of the benchmark run in seconds. Default is 10.
  • -t, --threads (int): Number of parallel generator worker threads. Default is 1.
  • -f, --format (str): Format of the IDs to generate during benchmark. Default is integer.
• Example:
  timeseed benchmark -d 5 -t 4 --format hex

timeseed info

Prints configuration info, environment settings, and statistics.

timeseed check

Performs diagnostic system checks on clocks, network adapters, and resolves machine IDs.