@oclif/command

What is @oclif/command?

@oclif/command is a framework for building command-line interface (CLI) applications. It provides a robust set of tools and conventions for creating, organizing, and managing CLI commands, arguments, and options.

What are @oclif/command's main functionalities?

Creating a Basic Command

This feature allows you to create a basic command that prints 'Hello, world!' to the console. The Command class is extended to define the behavior of the command.

const { Command } = require('@oclif/command');

class HelloWorldCommand extends Command {
  async run() {
    this.log('Hello, world!');
  }
}

HelloWorldCommand.run();

Adding Arguments and Flags

This feature allows you to add arguments and flags to your command. In this example, the command takes an optional 'name' argument and a 'greeting' flag to customize the output.

const { Command, flags } = require('@oclif/command');

class GreetCommand extends Command {
  async run() {
    const { args, flags } = this.parse(GreetCommand);
    const name = args.name || 'world';
    const greeting = flags.greeting || 'Hello';
    this.log(`${greeting}, ${name}!`);
  }
}

GreetCommand.args = [
  { name: 'name' }
];

GreetCommand.flags = {
  greeting: flags.string({ char: 'g', description: 'greeting to use' })
};

GreetCommand.run();

Command Aliases

This feature allows you to define aliases for your commands. In this example, the 'HelloWorldCommand' can be invoked using 'hw' or 'hello' as aliases.

const { Command } = require('@oclif/command');

class HelloWorldCommand extends Command {
  async run() {
    this.log('Hello, world!');
  }
}

HelloWorldCommand.aliases = ['hw', 'hello'];

HelloWorldCommand.run();

Other packages similar to @oclif/command

commander

Commander is a popular library for building command-line interfaces. It provides a simple and flexible API for defining commands, arguments, and options. Compared to @oclif/command, Commander is more lightweight and has fewer built-in features, but it is easier to get started with for simple CLI applications.

yargs

Yargs is another library for building command-line interfaces. It focuses on providing a powerful and user-friendly API for parsing arguments and generating help messages. Yargs offers more advanced argument parsing capabilities compared to @oclif/command, but it may require more configuration for complex CLI applications.

caporal

Caporal is a full-featured framework for building command-line applications. It provides a rich set of features for defining commands, arguments, options, and subcommands. Caporal is similar to @oclif/command in terms of functionality, but it has a different API and design philosophy.

README

@oclif/command

oclif base command

Changelog

1.2.24 (2018-02-14)

Bug Fixes

• updated deps (b643478)
• updated parser (69e7509)