Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CLI Reference

This page is generated from the Clap command tree in chromasync-cli.

chromasync

Dynamic color engine and theme generator CLI

Usage: chromasync <COMMAND>

Commands:
  generate     Generate theme artifacts from a seed color
  wallpaper    Generate theme artifacts from a wallpaper image
  batch        Execute a batch manifest with multiple generation jobs
  templates    List the available templates and where they were loaded from
  packs        List the discovered theme packs
  pack         Inspect a discovered theme pack
  targets      List available renderer targets and where they were loaded from
  preview      Show palette families and resolved semantic tokens
  tokens       Export resolved semantic tokens
  completions  Generate shell completion scripts
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help

  -V, --version
          Print version

chromasync generate

Generate theme artifacts from a seed color

Usage: generate [OPTIONS] --seed <SEED> --targets <TARGETS>

Options:
      --seed <SEED>
          Seed color in #RRGGBB format

      --template <TEMPLATE>
          Template name or path to a template TOML file. Optional if targets specify preferred_template

      --mode <MODE>
          Theme mode to generate
          
          [default: dark]
          [possible values: dark, light]

      --contrast <CONTRAST>
          Contrast selection heuristic used when resolving readable foregrounds
          
          [default: relative-luminance]
          [possible values: relative-luminance, apca-experimental]

      --chroma <CHROMA>
          Chroma strategy used when generating palette families
          
          [default: normal]
          [possible values: subtle, normal, vibrant, muted, industrial]

      --targets <TARGETS>
          Comma-separated list of target names or target TOML paths to generate

      --output <OUTPUT>
          Output directory for generated artifacts
          
          [default: chromasync]

  -h, --help
          Print help

chromasync wallpaper

Generate theme artifacts from a wallpaper image

Usage: wallpaper [OPTIONS] --image <IMAGE> --targets <TARGETS>

Options:
      --image <IMAGE>
          Wallpaper image path

      --template <TEMPLATE>
          Template name or path to a template TOML file. Optional if targets specify preferred_template

      --mode <MODE>
          Theme mode to generate
          
          [default: dark]
          [possible values: dark, light]

      --contrast <CONTRAST>
          Contrast selection heuristic used when resolving readable foregrounds
          
          [default: relative-luminance]
          [possible values: relative-luminance, apca-experimental]

      --chroma <CHROMA>
          Chroma strategy used when generating palette families
          
          [default: normal]
          [possible values: subtle, normal, vibrant, muted, industrial]

      --targets <TARGETS>
          Comma-separated list of target names or target TOML paths to generate

      --output <OUTPUT>
          Output directory for generated artifacts
          
          [default: chromasync]

  -h, --help
          Print help

chromasync batch

Execute a batch manifest with multiple generation jobs

Usage: batch --file <FILE>

Options:
      --file <FILE>
          Path to a TOML manifest containing multiple jobs

  -h, --help
          Print help

chromasync templates

List the available templates and where they were loaded from

Usage: templates

Options:
  -h, --help
          Print help

chromasync packs

List the discovered theme packs

Usage: packs

Options:
  -h, --help
          Print help

chromasync pack

Inspect a discovered theme pack

Usage: pack <COMMAND>

Commands:
  info  Show metadata and assets for an installed pack
  help  Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help

chromasync pack info

Show metadata and assets for an installed pack

Usage: info <NAME>

Arguments:
  <NAME>
          Pack name from pack.toml

Options:
  -h, --help
          Print help

chromasync targets

List available renderer targets and where they were loaded from

Usage: targets

Options:
  -h, --help
          Print help

chromasync preview

Show palette families and resolved semantic tokens

Usage: preview [OPTIONS] --seed <SEED> --template <TEMPLATE>

Options:
      --seed <SEED>
          Seed color in #RRGGBB format

      --template <TEMPLATE>
          Template name or path to a template TOML file

      --mode <MODE>
          Theme mode to preview
          
          [default: dark]
          [possible values: dark, light]

      --contrast <CONTRAST>
          Contrast selection heuristic used when resolving readable foregrounds
          
          [default: relative-luminance]
          [possible values: relative-luminance, apca-experimental]

      --chroma <CHROMA>
          Chroma strategy used when generating palette families
          
          [default: normal]
          [possible values: subtle, normal, vibrant, muted, industrial]

  -h, --help
          Print help

chromasync tokens

Export resolved semantic tokens

Usage: tokens [OPTIONS] --seed <SEED> --template <TEMPLATE>

Options:
      --seed <SEED>
          Seed color in #RRGGBB format

      --template <TEMPLATE>
          Template name or path to a template TOML file

      --mode <MODE>
          Theme mode to resolve
          
          [default: dark]
          [possible values: dark, light]

      --contrast <CONTRAST>
          Contrast selection heuristic used when resolving readable foregrounds
          
          [default: relative-luminance]
          [possible values: relative-luminance, apca-experimental]

      --chroma <CHROMA>
          Chroma strategy used when generating palette families
          
          [default: normal]
          [possible values: subtle, normal, vibrant, muted, industrial]

      --format <FORMAT>
          Serialization format for token export
          
          [default: json]
          [possible values: json]

  -h, --help
          Print help

chromasync completions

Generate shell completion scripts

Usage: completions <SHELL>

Arguments:
  <SHELL>
          Shell to generate completions for
          
          [possible values: bash, elvish, fish, powershell, zsh]

Options:
  -h, --help
          Print help