Typescript CLI Starter

A starter template for a Typescript CLI program
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is your basic Typescript CLI starter kit. Most of the README isn't going to make sense until I figure out exactly what and how I want the project to be built. In the meantime, feel free to use this as-is.

(back to top)

Built With

• Clap

(back to top)

Getting Started

Using this template is pretty easy - just take a look at the prerequisites and installation steps below.

Prerequisites

• Node
• Typescript
• Yarn (optional)

  This is what I use for my personal projects. The template will probably work with npm, but who's (whose?, that seems wrong) to say.

Installation

Most brute-force way to use this template

This'll get you up and running fairly quickly

1. Clone the repo

   # with https
   git clone https://github.com/MylesWritesCode/ts-cli-starter.git
   
   # or ssh
   git clone git@github.com:MylesWritesCode/ts-cli-starter.git
   

2. Remove the .git directory

   # cd into the cloned directory
   cd ts-cli-starter
   
   # delete `.git`
   rm -rf .git
   

3. Re-init git

   git init
   

4. Create a repo on your preferred git hosting site (e.g. GitHub)

5. Do your install

   yarn set version stable
   yarn install
   

6. Add your new remote to your local git instance

   git remote add origin <your url>
   git add .
   git commit -m 'init'
   git push origin <your branch>
   

7. Start hacking away

Simpler, since you're here

alternatively, the "I have a Github account" way

1. Github docs telling you to click the button above, labeled "Use this template".
2. ???
3. Profit by hacking away after you clone your new repo.

(back to top)

Usage

This repo is meant to be used as a template for Typescript CLI programs. Metadata files will be within the .meta folder. In there, you'll find places to put your project logo and screenshot. Importantly, you'll find a fresh README.md that you can use to overwrite this one.

Happy hacking!

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Myles Berueda

(back to top)