Ghost/ghost/pretty-cli
Hannah Wolfe b305b8582c Published new versions
- @tryghost/pretty-cli@1.0.0
2018-09-21 13:21:25 +01:00
..
test Pretty CLI - provide a styled sywac instance 2018-09-21 13:12:12 +01:00
.eslintrc.js Pretty CLI - provide a styled sywac instance 2018-09-21 13:12:12 +01:00
index.js Pretty CLI - provide a styled sywac instance 2018-09-21 13:12:12 +01:00
LICENSE Pretty CLI - provide a styled sywac instance 2018-09-21 13:12:12 +01:00
package.json Published new versions 2018-09-21 13:21:25 +01:00
pretty-cli.js Pretty CLI - provide a styled sywac instance 2018-09-21 13:12:12 +01:00
README.md Pretty CLI - provide a styled sywac instance 2018-09-21 13:12:12 +01:00
styles.js Pretty CLI - provide a styled sywac instance 2018-09-21 13:12:12 +01:00

Pretty CLI

A mini-module to style a sywac instance in a standard way

Install

Either: npm i @tryghost/pretty-cli --save

Or: yarn add @tryghost/pretty-cli

Usage

E.g. const prettyCLI = require('@tryghost/pretty-cli');

prettyCLI is a pre-styled instance of the sywac API.

See the sywac quickstart and config guide for full usage.

Example:

#!/usr/bin/env node
const prettyCLI = require('@tryghost/pretty-cli');


prettyCLI
  .command({
    flags: 'myTask [option]',
    desc: 'Run myTask',
    run: (argv) =>  { ... do something here }
  })
  .parseAndExit();

You can also grab a fresh instance of the api with prettyCLI.Api.get().

The style rules used are available at prettyCLI.styles.

Copyright & License

Copyright (c) 2018 Ghost Foundation - Released under the MIT license.