Nitrogen Poisonous Monoxide

    @tryghost/pretty-cli

    1.2.31 • Public • Published

    Pretty CLI

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

    Install

    Either: npm install @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();
    

    Pretty CLI also provides a common UI interface, providing log functions to output coloured messages to the UI:

    const ui = require('@tryghost/pretty-cli/ui');`
    
    ui.log.info('Done');
    ui.log.warn('Uh Oh', 'Something went wrong');
    

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

    The style rules used are available at prettyCLI.styles.

    Test

    • yarn lint run just eslint
    • yarn test run lint && tests

    Copyright & License

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

    Keywords

    none

    Install

    npm i @tryghost/pretty-cli

    DownloadsWeekly Downloads

    19,256

    Version

    1.2.31

    License

    MIT

    Unpacked Size

    5.48 kB

    Total Files

    7

    Last publish

    Collaborators

    • jonhickman
    • dylansharp
    • isabelfisher
    • lenabaidakova
    • kernalghost
    • hadret
    • minimaluminium
    • ronaldlangeveld
    • simonbackx
    • moreofmorris
    • joeegrigg
    • sanne-san
    • djordjevlais
    • bobvaneck
    • zimoatghost
    • allouis
    • gargol
    • rishabhgrg
    • erisds
    • johnonolan
    • kevinansfield
    • cobbspur
    • aileencgn
    • jloh
    • daniellockyer
    • sam-lord
    • pauladamdavis