oclif is a framework for building command-line interfaces (CLIs) in Node.js. It provides a robust set of tools and conventions for creating and managing CLI applications, including support for plugins, argument parsing, and command scaffolding.
Command Creation
This feature allows you to create new commands easily. The example demonstrates a simple 'Hello, world!' command.
const { Command } = require('@oclif/core');
class HelloWorldCommand extends Command {
async run() {
this.log('Hello, world!');
}
}
HelloWorldCommand.run();Argument Parsing
This feature provides built-in support for parsing command-line arguments and flags. The example shows a command that greets a user by name.
const { Command, flags } = require('@oclif/core');
class GreetCommand extends Command {
static flags = {
name: flags.string({ char: 'n', description: 'name to print' })
};
async run() {
const { flags } = this.parse(GreetCommand);
this.log(`Hello, ${flags.name || 'world'}!`);
}
}
GreetCommand.run();Plugins
This feature allows you to extend your CLI with plugins. The example demonstrates loading plugins within a command.
const { Command } = require('@oclif/core');
const { Plugins } = require('@oclif/plugin-plugins');
class MyCommand extends Command {
async run() {
const plugins = new Plugins(this.config);
await plugins.load();
this.log('Plugins loaded');
}
}
MyCommand.run();Commander is a popular library for building command-line interfaces in Node.js. It provides a simple and flexible API for defining commands, options, and arguments. Compared to oclif, Commander is more lightweight and less opinionated, making it a good choice for simpler CLI applications.
Yargs is another widely-used library for building CLI applications in Node.js. It offers powerful argument parsing capabilities and a rich set of features for handling complex command-line interfaces. Yargs is more feature-rich than Commander but still less structured than oclif, which provides a more comprehensive framework for CLI development.
Vorpal is a framework for building interactive command-line applications in Node.js. It supports features like command history, tab completion, and interactive prompts. Vorpal is more focused on creating interactive CLIs, whereas oclif is designed for building both simple and complex command-line tools.
oclif CLI
oclif CLIThis is the oclif CLI for the Open CLI Framework, that supports the development of oclif plugins and CLIs.
See the docs for more information.
The Getting Started tutorial is a step-by-step guide to introduce you to oclif. If you have not developed anything in a command line before, this tutorial is a great place to get started.
See Usage below for an overview of the oclif CLI.
Currently, Node 18+ is supported. We support the LTS versions of Node. You can add the node package to your CLI to ensure users are running a specific version of Node.
If you have been using version 1 of the oclif CLI there are some important differences to note when using the latest version.
oclif multi, oclif plugin, and oclif single have all been removed in favor of oclif generate, which generates an oclif based CLI using the hello-world example repo.
oclif hook is now oclif generate:hookoclif command is now oclif generate:commandVersion 2 now includes all the commands from the oclif-dev CLI. This means that you can now use a single CLI for all your oclif needs. These commands include:
oclif manifestoclif packoclif pack:deboclif pack:macosoclif pack:winoclif upload (formerly known as oclif-dev publish)oclif upload:deb (formerly known as oclif-dev publish:deb)oclif upload:macos (formerly known as oclif-dev publish:macos)oclif upload:win (formerly known as oclif-dev publish:win)oclif readmeCreating a CLI:
$ npx oclif generate mynewcli
? npm package name (mynewcli): mynewcli
$ cd mynewcli
$ ./bin/run.js --version
mynewcli/0.0.0 darwin-x64 node-v9.5.0
$ ./bin/run.js --help
USAGE
$ mynewcli [COMMAND]
COMMANDS
hello
help display help for mynewcli
$ ./bin/run.js hello world
hello world! (./src/commands/hello/world.ts)
oclif generate - Generate a new CLIoclif help - Display help for oclif.oclif init - Initialize a new oclif CLIoclif manifest - Generates plugin manifest json (oclif.manifest.json).oclif pack - Package an oclif CLI into installable artifacts.oclif promote - Promote CLI builds to a S3 release channel.oclif readme - Adds commands to README.md in current directory.oclif upload - Upload installable CLI artifacts to AWS S3.See the contributing guide.
FAQs
oclif: create your own CLI
The npm package oclif receives a total of 105,042 weekly downloads. As such, oclif popularity was classified as popular.
We found that oclif demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
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.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."