├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── cli.js ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 20 14 | - 18 15 | steps: 16 | - uses: actions/checkout@v4 17 | - uses: actions/setup-node@v4 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - run: npm install 21 | - run: npm test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /cli.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | import meow from 'meow'; 3 | import unicornFun from 'unicorn-fun'; 4 | 5 | const cli = meow(` 6 | Usage 7 | $ unicorn-fun [input] 8 | 9 | Options 10 | --postfix Lorem ipsum [Default: rainbows] 11 | 12 | Examples 13 | $ cli-name 14 | unicorns & rainbows 15 | $ cli-name ponies 16 | ponies & rainbows 17 | `, { 18 | importMeta: import.meta, 19 | flags: { 20 | postfix: { 21 | type: 'string', 22 | default: 'rainbows', 23 | }, 24 | }, 25 | }); 26 | 27 | console.log(unicornFun(cli.input[0] ?? 'unicorns', cli.flags)); 28 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) YOUR NAME (YOUR WEBSITE) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "unicorn-fun-cli", 3 | "version": "0.0.0", 4 | "description": "My awesome command-line tool", 5 | "license": "MIT", 6 | "repository": "YOUR-GITHUB-USERNAME/unicorn-fun-cli", 7 | "funding": "https://github.com/sponsors/YOUR-GITHUB-USERNAME", 8 | "author": { 9 | "name": "YOUR NAME", 10 | "email": "YOUR EMAIL", 11 | "url": "YOUR WEBSITE" 12 | }, 13 | "type": "module", 14 | "bin": { 15 | "unicorn-fun": "./cli.js" 16 | }, 17 | "engines": { 18 | "node": ">=18" 19 | }, 20 | "scripts": { 21 | "test": "xo && ava" 22 | }, 23 | "files": [ 24 | "cli.js" 25 | ], 26 | "keywords": [ 27 | "cli", 28 | "cli-app", 29 | "unicorn", 30 | "fun" 31 | ], 32 | "dependencies": { 33 | "meow": "^13.2.0", 34 | "unicorn-fun": "^0.0.0" 35 | }, 36 | "devDependencies": { 37 | "ava": "^6.1.2", 38 | "execa": "^8.0.1", 39 | "xo": "^0.58.0" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # node-cli-boilerplate 2 | 3 | > Boilerplate to kickstart creating a Node.js command-line tool 4 | 5 | This is what I use for [my own command-line tools](https://www.npmjs.com/~sindresorhus). 6 | 7 | Also check out [`node-module-boilerplate`](https://github.com/sindresorhus/node-module-boilerplate). 8 | 9 | ## Getting started 10 | 11 | **Click the "Use this template" button.** 12 | 13 | Alternatively, create a new directory and then run: 14 | 15 | ```sh 16 | curl -fsSL https://github.com/sindresorhus/node-cli-boilerplate/archive/main.tar.gz | tar -xz --strip-components=1 17 | ``` 18 | 19 | --- 20 | 21 | **Remove everything from here and above** 22 | 23 | --- 24 | 25 | # unicorn-fun-cli 26 | 27 | > My awesome command-line tool 28 | 29 | ## Install 30 | 31 | ```sh 32 | npm install --global unicorn-fun-cli 33 | ``` 34 | 35 | ## Usage 36 | 37 | ``` 38 | $ unicorn-fun --help 39 | 40 | Usage 41 | $ unicorn-fun [input] 42 | 43 | Options 44 | --postfix Lorem ipsum [Default: rainbows] 45 | 46 | Examples 47 | $ cli-name 48 | unicorns & rainbows 49 | $ cli-name ponies 50 | ponies & rainbows 51 | ``` 52 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import {execa} from 'execa'; 3 | 4 | test('main', async t => { 5 | const {stdout} = await execa('./cli.js', ['ponies']); 6 | t.is(stdout, 'ponies & rainbows'); 7 | }); 8 | --------------------------------------------------------------------------------