jonschlinkert / compgen

Node.js API for the bash(1) 'compgen' built-in, which lists all available bash commands, aliases, keywords, functions...

compgen

Node.js API for the bash(1) 'compgen' built-in, which lists all available bash commands, aliases, keywords, functions...

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save compgen

Usage

Add compgen to your node.js application with the following line of JavaScript:

const compgen = require('compgen');

compgen()
  .then(res => {
    console.log(res);
    // ...
    // giffiltr
    // gifinto
    // share
    // gem
    // git-receive-pack
    // gitk
    // git-upload-archive
    // git-credential-osxkeychain
    // git-cvsserver
    // git-shell
    // git-upload-pack
    // git
    // ... 1539 more items
  });

Examples

async usage

The following examples assume your code is inside an async function.

console.log(await compgen(flags[, options]));

// if no arguments are given, the `-abck` flags are used
console.log(await compgen());

// with flags
console.log(await compgen('-ac'));
console.log(await compgen('-abc'));
console.log(await compgen('-abck'));

// with flags and options
console.log(await compgen('-ac', { stdio: 'inherit' }));
console.log(await compgen('-abc', { stdio: 'inherit' }));
console.log(await compgen('-abck', { stdio: 'inherit' }));

See more available flags.

sync usage

console.log(compgen.sync(flags[, options]));

// if no arguments are given, the `-abck` flags are used
console.log(compgen.sync());

// with flags
console.log(compgen.sync('-ac'));
console.log(compgen.sync('-abc'));
console.log(compgen.sync('-abck'));

// with flags and options
console.log(compgen.sync('-ac', { stdio: 'inherit' }));
console.log(compgen.sync('-abc', { stdio: 'inherit' }));
console.log(compgen.sync('-abck', { stdio: 'inherit' }));

See more available flags.

Flags

Supports all of the bash(1) built-in compgen flags, including the following:

-a # lists all the aliases you can run
-b # lists all of the shell built-in comands you can run
-c # lists all the commands you can run
-A function # lists all the functions you can run
-A function -abc # lists all the above in one go
-ac | grep search_string # filter by the given search string 
-d # lists all directories
-e # lists all exported shell variables
-f # lists all files and functions
-g # lists all groups
-j # lists all jobs
-k # lists all of the shell reserved words/keywords you can run
-s # lists all services
-u # lists all userAlias names
-v # lists all shell variables

Check the man page for more information.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on April 17, 2018.