# cli-base

> Um framework para criação de ferramentas de linha de comando, seu foco são aplicações grandes com muitos scripts.

Latest version **0.0.6** (published 2015-07-17) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install cli-base
pnpm add cli-base
yarn add cli-base
bun add cli-base
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2015-07-17 |
| First published | 2015-07-17 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | André Timermann |
| Maintainers | atimermann |
| Keywords | cli, framework |

## Links

- npm: https://www.npmjs.com/package/cli-base
- Repository: https://bitbucket.org/atimermann/cli-base
- Homepage: https://bitbucket.org/atimermann/cli-base#readme
- npm.io page: https://npm.io/package/cli-base

## Dependencies (4)

- [yargs](https://npm.io/package/yargs.md) ~1.3.3
- [colors](https://npm.io/package/colors.md) ~1.0.3
- [lodash](https://npm.io/package/lodash.md) ~2.4.1
- [prompt](https://npm.io/package/prompt.md) ~0.2.14

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2015-07-17
- 0.1.0 (beta) — 2016-05-21
- 0.0.7 — 2016-05-21

## README

## Descrição

Um framework para criação de ferramentas de linha de comando, seu foco são aplicações grandes com muitos scripts.
Facilita organização e diminui trabalho com configuração de argumentos entre outros


## Exemplo de Uso

    cli.scriptDir = '../scripts';

    cli.help = function () {


        var help =
            "----------------------------------------\n" +
            "Configurando Ambiente de Desenvolvimento\n" +
            "----------------------------------------\n" +

                // TODO: Explicar como linkar o projeto direto no BIN do sistema pra ficar disponível instantaneamente
                // TODO: Explicar como linkar um projeto ao sindri no BITBICUCKET

            "----------------------------------------\n" +
            "Ajuda de comandos\n" +
            "----------------------------------------\n" +
            "sindri help ".red + "<command-name>".red.bold;

        util.print(help + "\n");


    };

    cli.load(__dirname);

* O Método **help** deve ser reescrito.
* **scriptDir** é o caminho onde os script ficarão
* O script deve ter o nome que será chamado na linha de comando exemplo:


    bdtool create-file

Devendo existir **create-file.js** na pasta **scriptDir**


## Criação de Scripts
Os scripts devem herdar o objeto cliBase e implementar alguns métodos:

### help
Imprime ajuda ao digitar help <comando>

### getShortInfo
Imprime descrição curta ao lista comandos

### main
Método de entrada, será chamado ao executar o comando relacionado ao seu script


##Exemplo:
    var CliBase = require('cli-base').cliBase;

    module.exports = Object.create(CliBase, {

        main: {
            value: function (argv) {
                "use strict";

        
            }
        }

    });

---
_Source: https://npm.io/package/cli-base · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._