$ Crafting Human Friendly CLIs with Node.js Core █

A workshop by Simon Plenderleith & Kevin Cunningham.

Getting ready for the workshop

1. Required software

You'll need to have this software installed:

Node.js >= v18.7.0 (how to install)
npm >= v8

Check that you have the software versions installed that you need for this workshop by running these commands in your terminal:

# Check Node.js version.
node --version

# Check npm version.
npm --version

2. Clone this repository with Git

You'll need to have this repository cloned so you can work on the coding exercises during the workshop:

git clone https://github.com/simonplend/workshop-crafting-human-friendly-clis.git

If you want to commit and push your work to your own repository on GitHub, you can fork this repository, then clone your fork rather than this repository directly. If you do create a fork, you'll want to sync it with this repository at the start of the workshop.

3. Open your editor and terminal

There are coding exercises throughout this workshop. To make sure you're ready:

Open this project in your code editor.
Open a terminal window for running commands, and cd to the directory for this project.

You're now ready to get started! 🚀

Workshop exercises

We're going to build a CLI tool with APIs that are available in Node.js core. This tool will allow us to input notes and store them as daily notes in Markdown files.

Create a skeleton CLI

You can generate a skeleton CLI by running the create-cli shell script in your terminal:

npm run create-cli

Run your CLI

npx takenote

simonplend / workshop-crafting-human-friendly-clis