CLI

🧬 UCID CLI

Generate remixable, segment-based IDs straight from your terminal. Whether you're tagging builds, creating user handles, or just vibing with entropy, UCID gives you full control over the character set, format, and flair.

🚀 Quick Start

To get started instantly, run UCID via npx:

npx unique-custom-id

If you've already installed the package locally, you can wire it into your project scripts:

"scripts": {
  "ucid": "ucid"
}

Then generate IDs with:

npm run ucid

🛠 CLI Options

UCID exposes a rich set of flags to customize your ID generation flow. Here's a breakdown of what each option does:

Flag	Description	Default
--uppercase	Include uppercase letters (A–Z) in the ID	false
--lowercase	Include lowercase letters (a–z) in the ID	false
--numbers	Include numeric characters (0–9)	true
--no-numbers	Disable numeric characters	-
--symbols	Include symbols (e.g. !@#$%)	false
--octets	Number of ID segments to generate	4
--octetLength	Length of each segment	8
--instances	Number of IDs to generate in one run	1
--octetSeparator	Character used to separate segments (e.g. -, _, :)	'-'
--octetFormat	Custom format string for octet lengths	''
--format	Use a predefined format that sets multiple options at once	null
--includeOnly	Use only the characters you specify (overrides other charset flags)	null
--timestamp	Include a timestamp (prefix or suffix)	null
--timestampFormat	Define the format of the timestamp (e.g. YYYYMMDD-HHmmss)	null
--prefix	Add a custom string before the generated ID	''
--suffix	Add a custom string after the generated ID	''
--template	Use a custom template with %id placeholders	null
--verbose	Return the full options object including the generated ID	false
--help	Display help message with usage examples	-

🧪 Examples

Generate a timestamped ID:

npx unique-custom-id --no-numbers --timestamp=suffix --timestampFormat=unix

Generate UUID:

npx unique-custom-id --format=uuid