Socket
Socket
Sign inDemoInstall

ascli

Package Overview
Dependencies
2
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

ascli

A uniform foundation for unobtrusive (ASCII art in) cli apps.


Version published
Maintainers
1
Weekly downloads
271,243
decreased by-9.46%

Weekly downloads

Readme

Source

ascli

Why? Some of us are not only programmers but also part-time artist. So am I. This is good. However, to limit myself a bit to a straight look of my CLI apps, I've created ascli based on the thought of not making things too fancy but still looking good. So, basically, this package is meant to be used by me but if you like my interpretation of unobtrusiveness and ease-of-use ... You are welcome!

example

Installation

npm install ascli

Usage

var ascli = require("ascli").app("myApp");
ascli.banner(ascli.appName.green.bold, "v1.0.0 by Foo Bar <foobar@example.com>");
console.log("Hello!");
// If it worked:
ascli.ok("It worked!");
// If it didn't:
ascli.fail("Nope, sorry.", /* exit code */ 1);
Using another alphabet

By default ascli uses a modified version of the straight ASCII alphabet. If you don't like it, you are free to replace it:

ascli.use("/path/to/my/alphabet.json");
// or
var myAlphabet = { ... };
ascli.use(myAlphabet);

See the alphabet/ directory for an example.

Using colors

ascli automatically looks up and translates ANSI terminal colors applied to the title string. For that it depends on colour.js which is also exposed as a property of the ascli namespace: ascli.colour / ascli.colors. Also means: You don't need another ANSI terminal colors dependency.

Indentation

ascli automatically indents all console output by one space just because it looks better with the banner.

Parsing command line arguments

opt.js will be pre-run on the ascli namespace and also exposed as ascli.optjs().

ascli.node   // Node executable
ascli.script // Executed script
ascli.opt    // Options as a hash
ascli.argv   // Remaining non-option arguments

License

Apache License, Version 2.0

Keywords

FAQs

Last updated on 28 May 2013

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc