@visulima/cerebro
v1.1.38
Published
A delightful toolkit for building Node-powered CLIs.
Downloads
2,957
Maintainers
Readme
boxen, colorize, cli-table3, command-line-args and fastest-levenshtein
I would recommend reading this guide on how to make user-friendly command-line tools.
[][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url]
Install
npm install @visulima/cerebro
yarn add @visulima/cerebro
pnpm add @visulima/cerebro
Usage
import Cli from "@visulima/cerebro";
// Create a CLI runtime
const cli = new Cli("cerebro");
// Your command
cli.addCommand({
name: "main:colors",
description: "Output colors", // This is used in the help output
execute: ({ logger }) => {
logger.info("Colors command");
},
});
await cli.run();
Now you can run your CLI with node index.js
and you should see the following output:
Supported Node.js Versions
Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.
Contributing
If you would like to help take a look at the list of issues and check our Contributing guild.
Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Credits
About
Related Projects
- oclif - The Open CLI Framework
- gluegun - A delightful toolkit for building TypeScript-powered command-line apps.
- meow - CLI app helper
- commander.js - node.js command-line interfaces made easy
- yargs - yargs the modern, pirate-themed successor to optimist.
License
The visulima package is open-sourced software licensed under the [MIT][license-url]
[typescript-url]: https://www.typescriptlang.org/ "TypeScript" "typescript" [license-image]: https://img.shields.io/npm/l/@visulima/cerebro?color=blueviolet&style=for-the-badge [license-url]: LICENSE.md "license" [npm-image]: https://img.shields.io/npm/v/@visulima/cerebro/latest.svg?style=for-the-badge&logo=npm [npm-url]: https://www.npmjs.com/package/@visulima/cerebro/v/latest "npm"