Git Product home page Git Product logo

nodesh's Introduction

"Travis-CI build status"

nodesh

Example Node CLI script

This repository holds some example code written to better understand the usage of NodeJS for command line tools. nodesh does not use any third-party scripts because I want to learn how to implement a script on my own. Actually, it does not do much and is propably of little interest to anyone.

Thre are some basic tests for nodesh inside the test directory. The tests use Mocha and can be run with npm test.

Installation

Clone this repository to your computer and run npm install -g inside. This will install the nodesh executable inside your $PATH.

Uninstall

To remove the script run npm remove -g nodesh.

Usage

See nodesh -u

USAGE: nodesh [OPTION ["arguments"]]

OPTIONS:
    -n "name"   Greet someone or say "Hello, world!"
    -u          Show usage message
    -v          Show version
    -t          Run mocha tests for nodesh

Example:

$ nodesh -n "Kevin"
Hello, Kevin!
$ nodesh -v
nodesh - v1.0.0
Example node cli app.

(c) 2017 by Kevin Gimbel <https://kevingimbel.com>
Report issues to https://github.com/kevingimbel/nodesh/issues

Scripts

Inside the scripts folder is a pre-commit git hook that executes the mocha test before a commit can be made. To use it, copy it to .git/hooks/.

nodesh's People

Contributors

kevingimbel avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.