CLI Installation

Install the uniku CLI using pre-built binaries or npm package managers

The uniku CLI can be installed via pre-built standalone binaries (recommended) or through npm package managers.

Pre-built Binary (Recommended)

Download and install a standalone binary with no Node.js dependency:

curl -fsSL https://raw.githubusercontent.com/jkomyno/uniku/main/install.sh | sh

This script:

• Detects your platform (macOS Intel/Apple Silicon, Linux x64)
• Downloads the appropriate pre-built binary
• Installs it to /usr/local/bin by default
• Makes it executable and adds it to your PATH

Supported platforms:

• macOS (Intel and Apple Silicon)
• Linux (x64)

Windows support coming soon. Use npm installation on Windows for now.

Custom Installation Directory

Override the default installation location using UNIKU_INSTALL_DIR:

Custom Directory

UNIKU_INSTALL_DIR=~/.local/bin curl -fsSL https://raw.githubusercontent.com/jkomyno/uniku/main/install.sh | sh

Make sure your custom installation directory is in your PATH:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Install Specific Version

Install a specific version instead of the latest:

UNIKU_VERSION=0.0.12 curl -fsSL https://raw.githubusercontent.com/jkomyno/uniku/main/install.sh | sh

You can combine both environment variables:

UNIKU_INSTALL_DIR=~/.local/bin UNIKU_VERSION=0.0.12 curl -fsSL https://raw.githubusercontent.com/jkomyno/uniku/main/install.sh | sh

npm Installation

Install globally using your preferred package manager:

pnpm

pnpm add -g @uniku/cli

Prerequisites: Node.js 18+ or Bun 1.0+ is required for npm installation.

Local Installation

You can also install it locally in a project:

pnpm

pnpm add -D @uniku/cli

Then run via npx or add to your package.json scripts:

package.json

{
  "scripts": {
    "gen:id": "uniku uuid --version 7"
  }
}

Verify Installation

Confirm the CLI is installed correctly:

uniku --version
# => @uniku/cli/0.0.12

Run a quick test:

uniku uuid
# => 550e8400-e29b-41d4-a716-446655440000

The pre-built binary is significantly faster to install and doesn’t require Node.js, making it ideal for CI/CD environments and Docker containers.

Updating

Pre-built Binary

Re-run the installation script to get the latest version:

curl -fsSL https://raw.githubusercontent.com/jkomyno/uniku/main/install.sh | sh

Or specify a version:

UNIKU_VERSION=0.0.13 curl -fsSL https://raw.githubusercontent.com/jkomyno/uniku/main/install.sh | sh

npm

Update using your package manager:

pnpm

pnpm update -g @uniku/cli

Uninstalling

Pre-built Binary

Remove the binary from your installation directory:

rm /usr/local/bin/uniku

Or if you used a custom directory:

rm ~/.local/bin/uniku

npm

pnpm

pnpm remove -g @uniku/cli

Next Steps

Generate IDs

Start generating IDs with all supported types

CLI Overview

Learn about available commands and options