🔮 A command line tool to optimize the repetitive actions.
HTML JavaScript
Latest commit f4a44ec Nov 15, 2016 @IonicaBizau ⬆️ 3.1.6 🎉
Permalink
Failed to load latest commit information.
bin
examples
lib
.gitignore
CONTRIBUTING.md
DOCUMENTATION.md
LICENSE
README.md
package.json

README.md

blah

$ blah

Patreon PayPal AMA Version Downloads Get help on Codementor

A command line tool to optimize the repetitive actions.

☁️ Installation

You can install the package globally and use it as command line tool:

$ npm i -g blah

Then, run blah --help and see what the CLI tool can do.

$ blah --help
Usage: blah <command> [options]

A command line tool to optimize the repetitive actions.

Commands:
  init  Inits the .blah directory.

Options:
  -b, --bump-version       Bumps the package.json version.
  -r, --readme             Creates the README.md file.
  -g, --gitignore          Creates the .gitignore file.
  -l, --license <license>  Generates a LICENSE file with copyright
                           information.
  -d, --docs <path>        Generates the markdown documentation
                           (DOCUMENTATION.md) for input file.
  -c, --contributing       Generates the CONTRIBUTING.md.
  -f, --force              When running `blah` without any arguments, force
                           overriding existing files.
  -v, --version            Displays version information.
  -h, --help               Displays this help.

Examples:
  $ blah --readme      # generates README.md
  $ blah --gitignore   # generates .gitignore
  $ blah --license mit # writes the MIT license in the LICENSE file
  $ blah --docs index.js # generates DOCUMENTATION.md from index.js, parsing JSDoc comments
  $ blah --bump-version major # bumps the major field of version, in package.json file

Happy Blahing!

Documentation can be found at https://github.com/IonicaBizau/blah.

📋 Example

Here is an example how to use this package as library. To install it locally, as library, you can do that using npm:

$ npm i --save blah
// Dependencies
var Blah = require("blah");

// Create a new Blah instance
var blh = new Blah("path/to/project");

// Generate the .gitignore file
blh.gitignore(function (err) {
    // Generated gitignore
});

// Create a copy of The KINDLY license
blh.license("KINDLY", function (err) {
    // Do something after creating the license
});

📝 Documentation

For full API reference, see the DOCUMENTATION.md file.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💰 Donations

Another way to support the development of my open-source modules is to set up a recurring donation, via Patreon. 🚀

PayPal donations are appreciated too! Each dollar helps.

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list.

  • ship-release—Publish new versions on GitHub and npm with ease.

📜 License

MIT © Ionică Bizău