{"id":13903109,"url":"https://github.com/pterm/cli-template","last_synced_at":"2025-04-27T00:32:10.051Z","repository":{"id":37283175,"uuid":"365816104","full_name":"pterm/cli-template","owner":"pterm","description":"⚗ The most advanced CLI template on earth! Featuring automatic releases, website generation and a custom CI-System out of the box. ","archived":false,"fork":false,"pushed_at":"2023-03-15T06:57:56.000Z","size":290,"stargazers_count":70,"open_issues_count":7,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-04T18:51:56.626Z","etag":null,"topics":["cd","ci","cli","generation","golang","hacktoberfest","modern","template"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pterm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-05-09T17:57:54.000Z","updated_at":"2025-02-10T16:59:29.000Z","dependencies_parsed_at":"2024-01-14T04:40:10.167Z","dependency_job_id":"6db8e2e6-1973-4555-a800-1bd5511ea669","html_url":"https://github.com/pterm/cli-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pterm%2Fcli-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pterm%2Fcli-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pterm%2Fcli-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pterm%2Fcli-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pterm","download_url":"https://codeload.github.com/pterm/cli-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251072279,"owners_count":21532004,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cd","ci","cli","generation","golang","hacktoberfest","modern","template"],"created_at":"2024-08-06T22:01:37.445Z","updated_at":"2025-04-27T00:32:09.669Z","avatar_url":"https://github.com/pterm.png","language":"Go","readme":"\u003ch1 align=\"center\"\u003ecli-template ✨\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e⚗ A template for beautiful, modern, cross-platform compatible CLI tools written with Go!\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/31022056/119876432-2e38bf00-bf28-11eb-859b-38f925b593e8.gif\" alt=\"Screenshot\"\u003e\n\u003c/p\u003e\n\n----\n\n\u003cp align=\"center\"\u003e\n\u003cstrong\u003e\u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\u003c/strong\u003e\n|\n\u003cstrong\u003e\u003ca href=\"https://github.com/pterm/cli-template/wiki/\"\u003eWiki\u003c/a\u003e\u003c/strong\u003e\n\u003c/p\u003e\n\n----\n\n|This template features|\n|----------------------|\n|[Modern Style 💎](#modern-style)|\n|[Build on top of cobra 🐍](#build-on-top-of-cobra)|\n|[Automatic Releases 🚀](#automatic-releases)|\n|[Easy installation for your users (one command) 🐥](#install-ready)|\n|[Automatic Website/Docs Generation 🌐](#automatic-website-generation)|\n|[Automatic Deployment 🔝](#automatic-deployment)|\n|[Update Checking ♻](#update-checking)|\n|[Custom CI-System 🤖](#custom-ci-system)|\n|[Custom Libraries 🔬](#custom-libraries)|\n\n## Getting Started\n\n**You can find an in-depth tutorial in the Wiki here: [Getting Started](https://github.com/pterm/cli-template/wiki/Getting-Started)**\n\n1. Click on \u003ckbd\u003eUse this template\u003c/kbd\u003e on the top of the page.\n1. Enable GitHub Pages and set the path to `/docs`.\n1. Create a personal access token (with repo scope) and add it as a repository secret (name: `REPO_ACCESS_TOKEN`).\n1. Clone and open your repository to change the description of your CLI in `./cmd/root.go`.\n1. 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)\n1. The setup is done and you can start to code!\n\nThis template uses [spf13/cobra](https://github.com/spf13/cobra) as CLI framework.  \nYou can find their documentation here: [cobra.dev](https://cobra.dev/)\n\n## Features\n\n### Modern Style\n\n\u003e [PTerm Documentation Link](https://pterm.sh/)\n\nThis template uses [PTerm](https://github.com/pterm/pterm) to provide colorful, cross-platform compatible output by default!  \nBy using PTerm, you can output progressbars, colored text, charts and many more.  \n\n### Build on top of cobra\n\u003e [Cobra Documentation Link](https://cobra.dev/)\n\nCobra is a popular CLI framework for Go.\n\n### Automatic Releases\n\n\u003e [Documentation link](https://github.com/pterm/cli-template/wiki/Automatic-Releases)\n\nOur custom made CI system will detect when you change the version of your CLI and will **automatically create a new GitHub release for you**.\nYou'll never have to deploy your CLI tools manually again!\n\n### Install Ready\n\n\u003e [Instl Documentation link](https://docs.instl.sh)\n\nThe [automatic releases](#automatic-releases) contain binaries, for the most common operating systems.  \nThis binaries can be installed using [instl.sh](https://docs.instl.sh).\n\nThis means that your users, can install your CLI Tool with a single command!  \nThe command will automatically be put into your README.md, after you click \u003ckbd\u003eUse this template\u003c/kbd\u003e.\n\nThe commands will look like below, depending on the OS, your user has.  \n\n**Windows**\n\n```powershell\niwr instl.sh/username/reponame/windows | iex \n```\n\n**macOS**\n\n```shell\ncurl -sSL instl.sh/username/reponame/macos | bash   \n```\n\n**Linux**\n\n```shell\ncurl -sSL instl.sh/username/reponame/linux | bash  \n```\n\n### Automatic Website Generation\n\n\u003e [Documentation link](https://github.com/pterm/cli-template/wiki/Automatic-Website-Generation)\n\nEvery time you push a new commit, a GitHub Pages website is created/updated, which documents your whole CLI tool automatically.\nYou don't need to document anything by yourself.\n\nYou only need to enable GitHub Pages by going to your repository settings (set the path to `/docs`).\n\n### Automatic Deployment\n\n\u003e [Goreleaser Documentation link](https://goreleaser.com)\n\nThis template uses Goreleaser to build binaries of GitHub releases, for the most common operating systems.  \nSince we feature [Automatic Releases](#automatic-releases), your whole deployment process is automated, when you increase\nthe version of your CLI tool.\n\n### Update Checking\n\nYour users will be notified if a new version of your tool is availble.\n\n### Custom CI-System\n\n\u003e [Documentation link](https://github.com/pterm/cli-template/wiki/Custom-CI-System)\n\nWe wrote a custom CI-System, which will be included in your repository.  \nIt sets up the template, creates/updates the website, writes docs for you and run your tests. (And much more!)\n\n### Custom Libraries\n\nWe use libraries, which were specially made for this template, to give you the best user experience without a ton of code.\n","funding_links":[],"categories":["cli"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpterm%2Fcli-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpterm%2Fcli-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpterm%2Fcli-template/lists"}