avatartion-cli

CLI port of Avatartion — generate Notion-style avatars from the command line.

Quick Start

npm install -g avatartion-cli

Or use without installing:

npx avatartion-cli generate

Commands

avatartion generate

Generate an avatar and output it as SVG or PNG.

| Flag | Short | Default | Description | |------|-------|---------|-------------| | --output <path> | -o | ./avatar.svg | Output file path | | --format <fmt> | -f | auto | Output format: svg or png (auto-detected from extension) | | --size <px> | -s | 512 | PNG output size in pixels | | --background <name> | -b | random | Background color name | | --face <n> | | random | Face index (1-8) | | --hair <n> | | random | Hair index (1-32) | | --eyes <n> | | random | Eyes index (1-6) | | --mouth <n> | | random | Mouth index (1-10) | | --outfit <n> | | random | Outfit index (1-25) | | --accessories <n> | | random | Accessories index (1-10) | | --facial-hair <n> | | random | Facial hair index (1-8) |

avatartion list

Show available options for each part category and background names.

avatartion decode <string>

Decode a shared avatar string and print the avatar configuration.

Examples

Random avatar to stdout:

avatartion generate

Custom avatar with specific parts:

avatartion generate --face 3 --hair 12 --eyes 2

Export as PNG at 1024px:

avatartion generate --format png --size 1024 --output my-avatar.png

Specific background color:

avatartion generate --background blue

Backgrounds

Available background names: transparent, white, red, yellow, green, blue, indigo, purple, pink.

Sharing

Avatars use the same encoding format as avatartion.com, so avatar strings can be shared and decoded across both the CLI and the website.