Git Product home page Git Product logo

tenon-cli's Introduction

Build Status Code Climate

NPM

Tenon CLI

This CLI was made to interact with the Tenon.io API. It utilizes Node and Commander,js to create a UNIX-style CLI.

Installation

Tenon CLI requires Node.js v4+ to run.

Install the dependencies and devDependencies and start the server.

$ npm install tenon-cli -g
$ tenon --key=XXXXXXXX --config=config.json https://example.com

Development

To develop this CLI further, modify the following files:

tenon.js - This is where the Tenon API is called and where the options included in these calls and used to manage the return data exists.

index.js - This is where the actual CommanderJS parser and all of the CLI specific data exists.

NOTE: ANY CHANGES MADE TO OPTIONS IN index.js MUST BE REFLECTED IN testIndex.js BECAUSE THEIR ENVIRONMENTS ARE SLIGHTLY DIFFERENT BUT THE TEST FILE MUST ACCURATELY MOCK THE PRODUCTION INDEX FILE IN ORDER FOR TESTING TO BE EFFECTIVE.

Then run

$ npm run compile

Then when you are ready to run it as a full blown CLI, run this from the root directory of the project:

$ npm install -g

(optional) Third:

$ karma start

Testing

Tests automatically utilize babel and ES6 standards, to run tests just enter (from the project root directory):

$ npm run test

This will run the tests using mocha.

To write new tests, just put them in the test/ folder and they will automatically be tested with the above command. Each test that utilizes/mocks the CLI arguments and their conversion to options must import/require testIndex.js.

tenon-cli's People

Contributors

tjkix2006 avatar ortutay avatar naterkane avatar

Watchers

Vanja Radovanović avatar James Cloos 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.