Skip to content

chromatic font

usage: chromatic font [-h] {delete,edit,list,register,rename,set-default} ...

positional arguments:
  {delete,edit,list,register,rename,set-default}
    delete              delete a user font from the registry
    edit                edit the attributes of a registered user font
    list                list all currently registered user fonts
    register            add a new font to the registry
    rename              rename a registered user font
    set-default         set a user font as the default font. it will be accessible as
                        `chromatic.DEFAULT_FONT`

options:
  -h, --help            show this help message and exit

chromatic font delete

usage: chromatic font delete [-h] [--font-dir DIRECTORY] NAME

positional arguments:
  NAME                  name of the registered font

options:
  -h, --help            show this help message and exit

env options:
  --font-dir DIRECTORY  path to font directory (env: CHROMATIC_FONTS=)

chromatic font edit

usage: chromatic font edit [-h] [--font-dir DIRECTORY] [--size SIZE] [--index INDEX]
                           [--encoding ENC] [--default | --no-default] [--font FILE]
                           NAME

positional arguments:
  NAME                  name of the registered font

options:
  -h, --help            show this help message and exit

env options:
  --font-dir DIRECTORY  path to font directory (env: CHROMATIC_FONTS=)

font attribute options:
  --size SIZE           size in pixels
  --index INDEX         which font face to load
  --encoding ENC        which font encoding to use
  --default, --no-default
                        whether to set this font as the new default font

font options:
  --font FILE           path to truetype font file

chromatic font list

usage: chromatic font list [-h] [--font-dir DIRECTORY] [--json]

options:
  -h, --help            show this help message and exit

env options:
  --font-dir DIRECTORY  path to font directory (env: CHROMATIC_FONTS=)

formatting options:
  --json                emit entries in JSON format (default: False)

chromatic font register

usage: chromatic font register [-h] [--font-dir DIRECTORY] [--size SIZE] [--index INDEX]
                               [--encoding ENC] [--default | --no-default] [-s]
                               FONT [NAME]

positional arguments:
  FONT                  path to truetype font file
  NAME                  name of the registered font

options:
  -h, --help            show this help message and exit

env options:
  --font-dir DIRECTORY  path to font directory (env: CHROMATIC_FONTS=)

font attribute options:
  --size SIZE           size in pixels
  --index INDEX         which font face to load
  --encoding ENC        which font encoding to use
  --default, --no-default
                        whether to set this font as the new default font

filesystem options:
  -s, --symbolic        create a symlink instead of copying the file. like `ln -s TARGET
                        LINK_NAME`, this will fail if the link name already exists (default:
                        False)

chromatic font rename

usage: chromatic font rename [-h] [--font-dir DIRECTORY] NAME NEWNAME

positional arguments:
  NAME                  name of the registered font
  NEWNAME               new name to give the registered font

options:
  -h, --help            show this help message and exit

env options:
  --font-dir DIRECTORY  path to font directory (env: CHROMATIC_FONTS=)

chromatic font set-default

usage: chromatic font set-default [-h] [--font-dir DIRECTORY] NAME

positional arguments:
  NAME                  name of the registered font

options:
  -h, --help            show this help message and exit

env options:
  --font-dir DIRECTORY  path to font directory (env: CHROMATIC_FONTS=)