{"id":13902930,"url":"https://github.com/boilertown/node-cli-boilerplate","last_synced_at":"2025-05-08T01:15:57.960Z","repository":{"id":144644965,"uuid":"525213323","full_name":"boilertown/node-cli-boilerplate","owner":"boilertown","description":"The boilerplate with opinionated setup to help you quickly kickstart your Node.js CLI app.","archived":false,"fork":false,"pushed_at":"2023-03-01T09:59:40.000Z","size":698,"stargazers_count":7,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-08T01:15:52.367Z","etag":null,"topics":["cli","eslint","nodejs","prettier","tsup","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/boilertown.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-16T03:06:38.000Z","updated_at":"2024-07-02T02:57:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"f19dcbfa-a284-4890-b74e-a8a7074a796e","html_url":"https://github.com/boilertown/node-cli-boilerplate","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boilertown%2Fnode-cli-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boilertown%2Fnode-cli-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boilertown%2Fnode-cli-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boilertown%2Fnode-cli-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boilertown","download_url":"https://codeload.github.com/boilertown/node-cli-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252978810,"owners_count":21834920,"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":["cli","eslint","nodejs","prettier","tsup","typescript"],"created_at":"2024-08-06T22:01:30.323Z","updated_at":"2025-05-08T01:15:57.937Z","avatar_url":"https://github.com/boilertown.png","language":"TypeScript","funding_links":[],"categories":["cli"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e♨️ Node CLI Boilerplate\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cp\u003e\n    A Node.js boilerplate with opinionated setup to help you kickstart your own CLI.\n  \u003c/p\u003e\n  \u003cimg src=\"https://img.shields.io/github/license/boilertown/node-cli-boilerplate?style=flat-square\" alt=\"MIT license\" \u003e\n\u003c/div\u003e\n\n## The Setup\n\n- [TypeScript][typescript-url]\n- Linting with [Eslint][eslint-url] and code formatting with [Prettier][prettier-url]\n- Conventional commit messages with [Commitlint][commitlint-url]\n- Build with [tsup][tsup-url]\n- [Vitest][vitest-url] for Unit test\n- Automated release with [changesets][changesets-url]\n\n## Get Started\n\n- Use [Boilertown](https://github.com/boilertown/create-boilertown) CLI.\n\n  ```sh\n  # npm\n  npm create boilertown@latest -- -b node-cli-boilerplate\n\n  # yarn\n  yarn create boilertown -b node-cli-boilerplate\n\n  # pnpm\n  pnpm create boilertown -b node-cli-boilerplate\n\n  # bun\n  bun create boilertown/node-cli-boilerplate [cli-name]\n  ```\n\n- Click the green \"Use this template\" button to generate a new repository with the same structure and files.\n\n  \u003cimg src=\"https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png\" alt=\"Use this template button\" width=\"500\"\u003e\n\n  [Ref: Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)\n\n## Development\n\n- Run the app in development mode:\n\n  ```sh\n  pnpm dev\n  ```\n\n- Build the app:\n\n  ```sh\n  pnpm build\n  ```\n\n- Create changeset:\n\n  ```sh\n  pnpm changeset\n  ```\n\n## Release \u0026 Publish app\n\nThis boilerplate uses [changesets][changesets-url] to automatically generate `CHANGELOG`, create releases and publish to NPM registry via GitHub Actions. You can see action details at [release.yml](/.github/workflows//release.yml).\n\nTo automating publish your app, follow these steps:\n\n- Create a `NPM_TOKEN`. [See this article for more details](https://docs.npmjs.com/creating-and-viewing-access-tokens). Make sure the type of access token is **Automation**.\n\n- [Follow this instruction](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to add the created token to your GitHub Actions secrets. Name of the secret is `NPM_TOKEN`.\n\n- Install [changeset bot](https://github.com/apps/changeset-bot).\n\n- [Adding changeset and commit](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md#i-am-in-a-single-package-repository).\n\n**P/S**: Remember to check the `Allow GitHub Actions to create and approve pull requests` in your repo Settings \u003e Actions \u003e General \u0026 scroll to Workflow permissions.\n\n## Contributing\n\n**node-cli-boilerplate** ❤️ your contributions. If you have any ideas, suggestions, fixes, feel free to contribute.\n\n[boilertown-url]: https://github.com/boilertown\n[typescript-url]: https://www.typescriptlang.org\n[eslint-url]: https://eslint.org\n[commitlint-url]: https://github.com/conventional-changelog/commitlint\n[prettier-url]: https://prettier.io\n[changesets-url]: https://github.com/changesets/changesets\n[tsup-url]: https://tsup.egoist.sh\n[vitest-url]: https://vitest.dev\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboilertown%2Fnode-cli-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboilertown%2Fnode-cli-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboilertown%2Fnode-cli-boilerplate/lists"}