https://github.com/rakentaja/cli

Rakentaja cli
https://github.com/rakentaja/cli

bash boilerplate cli command-line javascript nodejs terminal typescript

Last synced: 26 days ago
JSON representation

Rakentaja cli

• Host: GitHub
• URL: https://github.com/rakentaja/cli
• Owner: rakentaja
• Created: 2019-11-14T22:03:19.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-04T20:29:40.000Z (almost 2 years ago)
• Last Synced: 2024-10-09T14:31:37.597Z (about 1 month ago)
• Topics: bash, boilerplate, cli, command-line, javascript, nodejs, terminal, typescript
• Language: TypeScript
• Size: 123 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        


## Motivation

Are you sick of configuring your projects from scratch over and over again ? 

Are you a library author ?

Do you experiment much ?

This is the tool you need.

## Installation

Install globally with `npm i -g @rakentaja/cli` or  `yarn global add @rakentaja/cli`

## Configuration

Add a `rakentaja.json` to the root of your tempaltes folder having the structure : 

```

{

  keys: {[key:string]:any} // Default keys for the templates in the project

  commands: string[]; // Commands to run after project is created

  ignore: string[] // An array of glob strings

}

```

## Usage

```

rakentaja  [target]

Create a project from template

Positionals:

  source  Source directory or a git URL. If that is a valid git URL, rakentaja

          will attempt to clone the repository.

          NOTE: Git support will arive in next major version!           [string]

  target  Target directory to generate project          [string] [default: "./"]

Options:

  --version  Show version number                                       [boolean]

  --help     Show help                                                 [boolean]

```

Pass the template directory : 

```

rakentaja myTemplateFolder ./MyProject

```

# Roadmap

- Support `.zip` packages for templates

- Add git support

## Known Issues

**!!! Git support is not working yet!**

## Contribution

Feel free to add tests and report bugs.

Please make a pull request to [dev](https://github.com/rakentaja/cli/tree/dev) branch

And **please do not forget to bump the version!** [Check out SemVer](https://semver.org)

## Credits

## LICENCE