SoftwareTemplates CLI

---

A simple and powerful cli for setting up your projects more quickly

---

Project Information

This project provides a simple cli for setting up new projects more quickly. The organisation contains a lot of templates for many different languages and software frameworks. You can use this cli to easily use the templates and skip the anoying process of creating your projects base structure.

Usage

Init your first project

    softwareTemplates init --initGit --template test-template

Commands

1. Init:

softwareTemplates init # general init command for new projects

Flags

1. --initGit or --git or --ig If this flag is added to the init command, a new git repository will be initialized on project creation. If it is not provided, this will be validated by a cli prompt.

2. --template or -t If this flag is provided it will directly choose a template. If the template does not exists the cli terminates. If this flag is not provided the the cli will open a prompt to select a template

3. --projectName or -p If this flag is added to the init command, the project name will automatically selected. If this flag is not provided the cli will open a input prompt

4. --customTemplateUrl If you want to use templates that are not from the softwareTemplates cli, you can do so with this flag. Just insert the git url of you repository and the template will be used.
   NOTE: The templates must have the valid init structure. Otherwise it will not work with the cli.

Installation

1. Choose the latest version from the releases tab
2. Select the version that is used for your operating system
3. Move to your program files

Linux/MacOS:

   sudo mv ./softwareTemplates /usr/local/bin/softwareTemplates

Windows:
Move copy your file to C:\Program Files

Creating templates

If you want to create your own project template for this cli, you can create a new repository and start writing your project infrastructure.

If you want to use shell scripts to initialize your project you can put files called init.sh and init.bat into your root directory of the repository. If you want your project to be supported directly by the cli, you can try to transfer the ownership of your repository to the SoftwareTemplates organisation. But I will check your template, because the cli only supports safe templates out of the box.

If you want to use a custom repository use the --customTemplateUrl flag for using foreign templates.