CLI

Learn how to generate themes using CLI commands.

Usage

Before running the following commands, you need to install @yamada-ui/cli and execute the init command. For more details, please see here.

Generate a Theme

When you run the theme command, the theme will be generated at the specified path.

pnpm yamada-cli theme

npm yamada-cli theme

yarn yamada-cli theme

bun yamada-cli theme

If you don't specify a path, the theme will be generated in ./theme.

Usage: pnpm yamada-cli theme [options] [path]

generate theme to your project

Arguments:
  path                 path to the theme directory

Options:
  --cwd <path>         current working directory
  -c, --config <path>  path to the config file (default: "ui.json")
  -o, --overwrite      overwrite existing directory. (default: false)
  -j, --js             use js instead of ts
  -f, --format         format the output files.
  -l, --lint           lint the output files.
  -h, --help           display help for command

Check the Differences

When you run the diff command, you can check the difference between the local and remote themes.

pnpm yamada-cli diff theme

npm yamada-cli diff theme

yarn yamada-cli diff theme

bun yamada-cli diff theme

Usage: pnpm yamada-cli diff [options] [component]

check for updates against the registry

Arguments:
  component            component to check

Options:
  --cwd <path>         current working directory
  -c, --config <path>  path to the config file (default: "ui.json")
  -s, --sequential     run tasks sequentially. (default: false)
  -d, --detail         show detailed changes (default: false)
  -h, --help           display help for command

Update the theme

When you run the update command, the theme will be updated.

pnpm yamada-cli update theme

npm yamada-cli update theme

yarn yamada-cli update theme

bun yamada-cli update theme

Usage: pnpm yamada-cli update [options] [components...]

update components in your project

Arguments:
  components           components to update

Options:
  --cwd <path>         current working directory
  -c, --config <path>  path to the config file (default: "ui.json")
  -i, --install        install dependencies (default: false)
  -s, --sequential     run tasks sequentially. (default: false)
  -f, --format         format the output files.
  -l, --lint           lint the output files.
  -h, --help           display help for command

Update typings

When you run the tokens command, you can update the customized theme typings. This typings are used for Style Props.

pnpm yamada-cli tokens

npm yamada-cli tokens

yarn yamada-cli tokens

bun yamada-cli tokens

If you don't specify a path, the theme.path will be used.

Usage: pnpm yamada-cli tokens [options] [path]

generate theme typings

Arguments:
  path                 path to the theme file

Options:
  --cwd <path>         current working directory
  -c, --config <path>  path to the config file (default: "ui.json")
  -o, --out <path>     output path
  -f, --format         format the output file
  -l, --lint           lint the output file
  -h, --help           display help for command