Base Template CLI

Overview

CLI tool of Base Template Repository.

Requirements

You have to clone either base_template or base_template_ja repo to your machine before using Base Template CLI.

git clone git@github.com:haru52/base_template.git
# or
git clone git@github.com:haru52/base_template_ja.git

Installation

pip install base-template-cli

Usage

Usage: base-template-cli [OPTIONS] COMMAND [ARGS]...

  Base Template CLI.

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  apply  Apply (Copy) Base Template boilerplates to the destination repo.

Usage: base-template-cli apply [OPTIONS]
                         BASE_TEMPLATE_ROOT_PATH

  Apply (Copy) Base Template boilerplates to the destination repo.

Options:
  -d, --dst TEXT          Destination repo root path.
  -t, --target-dirs TEXT  Target directories to copy (e.g., .husky,
                          .github/ISSUE_TEMPLATE). If you don't specify this
                          option, this command copies all files of Base
                          Template to the destination repo. If you want to
                          copy only root files, use --only-root option.
  -r, --only-root         Copy only root directory files of Base Template
                          repo.
  -l, --lang TEXT         Language of Base Template. `en` or `ja`.
  -h, --help              Show this message and exit.

Update

pip install -U base-template-cli

Uninstall

pip uninstall base-template-cli

Versioning policy

Semantic Versioning 2.0.0

License

MIT

Contributing

Contributing Guideline

Documentation

Documentation | base_template_cli

Author

haru