GitHub
Seashell and Bubbles

Shell
Yes

Seas the Command Line

This starter template is guaranteed to make waves. Whether you’re a seasoned sailor or exploring uncharted waters, this package has all the essentials for smooth sailing and writing your own CLI tools.

When you dive in

Run the following within the Terminal:

Surfing the Code

Screencast Placeholder

Packed to the Gills: Default Packages

Yargs
This entire project is built around Yargs. This is a Node.js library makes it easy to build interactive command line tools.
Chalk
Chalk is perfect for styling text.
BoxerJS
Create boxes within the Terminal. (I made this, too!)
Inquirer
Want to build an interactive interface? Inputs, Checkboxes, Select, Searches, Password, etc.
fs-extra
Adds file system methods aren’t included in the native fs module.
Coral
RedwoodJS Terminal
Made with Shell Yes!

Free Screecast

tide-y up your skills

Personally, I learn best by through “reel” world projects and studying how other people solve simliar problems. I recorded a screencast sharing my process. I’d love to share it with you. Just let me know where to send it.

Terminal for Cabana Compnents
Made with Shell Yes!
Starfish
Horizontal Divider

Dock-umentation

# Get Started

Installation

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna

npm install lemon-squeezy

Aliqua sit amet. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris

yarn add lemon-squeezy

nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

depedencies

quick Started

# Methods

Installation

depedencies

quick start

# Examples

Create Redwood

Cabana Components

Gold Seashell

Catch of the Day

these packages are not included,
but they're still some of my faovrites

figlet
This entire project is built around Yargs. This is a Node.js library makes it easy to build interactive command line tools.
semver
Do you need to compare versions? Semver is perfect for handling all the various us cases.
ora
Need a spinner? Reach for Ora.
ink
We’re using Chalk to handle all of our styling, but Ink is worth checking out. Especially, if you want to do more.
prompts
Out of the box, we’ve provided Inquirer, but Prompts is a great alternative.

Shore Fire Testing

Local Development

Chances are, as you work on your code locally, you’ll want to test it out within the Terminal.

NAME-OF-YOUR-APP is the name of the main JavaScript file. COMMAND is the CLI command you want to run.

Ship It

Deploying to NPM

When you get ready to deploy your application, you’ll probably want to consider putting it on npm. This is considered the standard.

  1. Create an account on npm
  2. Login to npm with your credentials.
  3. Publish the package with npm publish.
Horizontal Divider
seaweed seaweed

Frequently Asked Questions

and their reef-ined answers

horizontal divider