Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/haru52/base_template_cli

CLI tool of Base Template Repository.
https://github.com/haru52/base_template_cli

base-template template

Last synced: 18 days ago
JSON representation

CLI tool of Base Template Repository.

Host: GitHub
URL: https://github.com/haru52/base_template_cli
Owner: haru52
License: mit
Created: 2022-07-17T08:32:49.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-05-27T10:42:15.000Z (6 months ago)
Last Synced: 2024-10-11T01:55:03.859Z (about 1 month ago)
Topics: base-template, template
Language: Python
Homepage: https://pypi.org/project/base-template-cli/
Size: 1.37 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 9
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md

Awesome Lists containing this project

README

        # Base Template CLI

[![Test](https://github.com/haru52/base_template_cli/actions/workflows/test.yml/badge.svg)](https://github.com/haru52/base_template_cli/actions/workflows/test.yml)

[![Release](https://github.com/haru52/base_template_cli/actions/workflows/release.yml/badge.svg)](https://github.com/haru52/base_template_cli/actions/workflows/release.yml)

[![CodeQL](https://github.com/haru52/base_template_cli/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/haru52/base_template_cli/actions/workflows/github-code-scanning/codeql)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen.github.io/cz-cli/)

[![semantic-release: conventionalcommits](https://img.shields.io/badge/semantic--release-conventionalcommits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

## Overview

CLI tool of [Base Template Repository](https://github.com/haru52/base_template#readme).

## Requirements

| Tool                                                                                                                                      | Version               |

| ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |

| [Base Template Repository](https://github.com/haru52/base_template) or its [Japanese version](https://github.com/haru52/base_template_ja) | ^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.

```sh

git clone [email protected]:haru52/base_template.git

# or

git clone [email protected]:haru52/base_template_ja.git

```

## Installation

```sh

pip install base-template-cli

```

## Usage

```console

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.

```

```console

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

```sh

pip install -U base-template-cli

```

## Uninstall

```sh

pip uninstall base-template-cli

```

## Versioning policy

[Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html)

## License

[MIT](https://github.com/haru52/base_template_cli/blob/main/LICENSE)

## Contributing

[Contributing Guideline](https://haru52.github.io/base_template_cli/CONTRIBUTING.html)

## Documentation

[Documentation | base_template_cli](https://haru52.github.io/base_template_cli/)

## Author

[haru](https://haru52.com/)