Skip to main content

CLI tool of Base Template Repository.

Project description

Base Template CLI

Test Release CodeQL Contributor Covenant Commitizen friendly semantic-release: conventionalcommits

Overview

CLI tool of Base Template Repository.

Requirements

Tool Version
Base Template Repository or its Japanese version ^7.8.0 or ^6.8.0 (ja)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

base_template_cli-3.0.2.tar.gz (123.1 kB view hashes)

Uploaded Source

Built Distribution

base_template_cli-3.0.2-py3-none-any.whl (7.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page