Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pterm/cli-template

⚗ The most advanced CLI template on earth! Featuring automatic releases, website generation and a custom CI-System out of the box.
https://github.com/pterm/cli-template

cd ci cli generation golang hacktoberfest modern template

Last synced: 3 months ago
JSON representation

⚗ The most advanced CLI template on earth! Featuring automatic releases, website generation and a custom CI-System out of the box.

Host: GitHub
URL: https://github.com/pterm/cli-template
Owner: pterm
License: mit
Created: 2021-05-09T17:57:54.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2023-03-15T06:57:56.000Z (over 1 year ago)
Last Synced: 2024-06-21T18:47:37.205Z (5 months ago)
Topics: cd, ci, cli, generation, golang, hacktoberfest, modern, template
Language: Go
Homepage:
Size: 283 KB
Stars: 62
Watchers: 4
Forks: 5
Open Issues: 7
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
cli-template ✨


⚗ A template for beautiful, modern, cross-platform compatible CLI tools written with Go!








----



Getting Started

|

Wiki



----

|This template features|

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

|[Modern Style 💎](#modern-style)|

|[Build on top of cobra 🐍](#build-on-top-of-cobra)|

|[Automatic Releases 🚀](#automatic-releases)|

|[Easy installation for your users (one command) 🐥](#install-ready)|

|[Automatic Website/Docs Generation 🌐](#automatic-website-generation)|

|[Automatic Deployment 🔝](#automatic-deployment)|

|[Update Checking ♻](#update-checking)|

|[Custom CI-System 🤖](#custom-ci-system)|

|[Custom Libraries 🔬](#custom-libraries)|

## Getting Started

**You can find an in-depth tutorial in the Wiki here: [Getting Started](https://github.com/pterm/cli-template/wiki/Getting-Started)**

1. Click on Use this template on the top of the page.

1. Enable GitHub Pages and set the path to `/docs`.

1. Create a personal access token (with repo scope) and add it as a repository secret (name: `REPO_ACCESS_TOKEN`).

1. Clone and open your repository to change the description of your CLI in `./cmd/root.go`.

1. After you have set up your programm you have to create the very first release manually (`v0.0.1`), to initialize the CI-System. (Don't worry if your CLI tool doesn't do anything yet. It's common that the `v0.0.1` release is just the plain project setup)

1. The setup is done and you can start to code!

This template uses [spf13/cobra](https://github.com/spf13/cobra) as CLI framework.  

You can find their documentation here: [cobra.dev](https://cobra.dev/)

## Features

### Modern Style

> [PTerm Documentation Link](https://pterm.sh/)

This template uses [PTerm](https://github.com/pterm/pterm) to provide colorful, cross-platform compatible output by default!  

By using PTerm, you can output progressbars, colored text, charts and many more.  

### Build on top of cobra

> [Cobra Documentation Link](https://cobra.dev/)

Cobra is a popular CLI framework for Go.

### Automatic Releases

> [Documentation link](https://github.com/pterm/cli-template/wiki/Automatic-Releases)

Our custom made CI system will detect when you change the version of your CLI and will **automatically create a new GitHub release for you**.

You'll never have to deploy your CLI tools manually again!

### Install Ready

> [Instl Documentation link](https://docs.instl.sh)

The [automatic releases](#automatic-releases) contain binaries, for the most common operating systems.  

This binaries can be installed using [instl.sh](https://docs.instl.sh).

This means that your users, can install your CLI Tool with a single command!  

The command will automatically be put into your README.md, after you click Use this template.

The commands will look like below, depending on the OS, your user has.  

**Windows**

```powershell

iwr instl.sh/username/reponame/windows | iex 

```

**macOS**

```shell

curl -sSL instl.sh/username/reponame/macos | bash   

```

**Linux**

```shell

curl -sSL instl.sh/username/reponame/linux | bash  

```

### Automatic Website Generation

> [Documentation link](https://github.com/pterm/cli-template/wiki/Automatic-Website-Generation)

Every time you push a new commit, a GitHub Pages website is created/updated, which documents your whole CLI tool automatically.

You don't need to document anything by yourself.

You only need to enable GitHub Pages by going to your repository settings (set the path to `/docs`).

### Automatic Deployment

> [Goreleaser Documentation link](https://goreleaser.com)

This template uses Goreleaser to build binaries of GitHub releases, for the most common operating systems.  

Since we feature [Automatic Releases](#automatic-releases), your whole deployment process is automated, when you increase

the version of your CLI tool.

### Update Checking

Your users will be notified if a new version of your tool is availble.

### Custom CI-System

> [Documentation link](https://github.com/pterm/cli-template/wiki/Custom-CI-System)

We wrote a custom CI-System, which will be included in your repository.  

It sets up the template, creates/updates the website, writes docs for you and run your tests. (And much more!)

### Custom Libraries

We use libraries, which were specially made for this template, to give you the best user experience without a ton of code.