Find Similar Packages for oclif
Search packages..
1 Year
oclifSimilar Packages:
Package Weekly Downloads Trend
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
oclif152,6249,138275 kB13a day agoMIT
Similar Npm Packages to oclif

oclif is an open-source CLI framework developed by Heroku for building command-line interfaces (CLIs) with Node.js. It provides a powerful set of tools and features that make it easier to create, manage, and deploy CLI applications. With oclif, developers can define commands, handle arguments and options, manage plugins, and create a consistent user experience across different commands. Its extensibility and modular architecture make it suitable for building complex CLI applications that require a high degree of customization.

While oclif is a robust choice for CLI development, there are several alternatives that also provide great functionality:

  • commander is a popular and widely-used library for building command-line interfaces in Node.js. It offers a simple and intuitive API for defining commands, options, and arguments. Commander is lightweight and easy to use, making it an excellent choice for developers who need to create straightforward CLI applications without the overhead of more complex frameworks. Its flexibility allows for quick setup and rapid development, making it a favorite among many developers.
  • vorpal is another CLI framework that focuses on providing an interactive command-line experience. It allows developers to create rich, interactive command-line applications with features like command history, tab completion, and customizable prompts. Vorpal is particularly useful for building applications that require user interaction and dynamic command execution. If your CLI application needs to engage users in a more interactive manner, vorpal is a great option.
  • yargs is a powerful library for parsing command-line arguments and options. It provides a simple and flexible API for defining commands and handling user input. Yargs is particularly known for its ability to create complex command-line interfaces with ease, allowing developers to define commands, subcommands, and options in a structured manner. If you need a library that excels at argument parsing and command handling, yargs is an excellent choice.

To see how oclif compares with commander, vorpal, and yargs, check out the comparison: Comparing commander vs oclif vs vorpal vs yargs.

README for oclif

oclif CLI

Version Downloads/week License

🗒 Description

This is the oclif CLI for the Open CLI Framework, that supports the development of oclif plugins and CLIs.

See the docs for more information.

🚀 Getting Started Tutorial

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.

📌 Requirements

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.

📌 Migrating from V1

If you have been using version 1 of the oclif CLI there are some important differences to note when using the latest version.

Breaking Changes

  • 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.
    • The reason is that there's not enough of a meaningful difference between a "multi command cli", a "single command cli", and a "plugin" to justify the maintenance cost. The generated CLI can be easily used for any of those use cases.
  • oclif hook is now oclif generate:hook
  • oclif command is now oclif generate:command

New Commands

Version 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 manifest
  • oclif pack
  • oclif pack:deb
  • oclif pack:macos
  • oclif pack:win
  • oclif 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 readme

🏗 Usage

Creating 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)

📚 Examples

🔨 Commands

Command Topics

🚀 Contributing

See the contributing guide.

🏭 Related Repositories

  • @oclif/core - Base library for oclif. This can be used directly without the generator.
  • @oclif/test - Test helper for oclif.

🦔 Learn More

npm-compare.com is an independent website designed to help developers choose the most suitable npm packages. We are not affiliated with npm, Inc or npmjs.com, the official website for the npm registry. Please note that npm is a registered trademark of npm, Inc. For more details, please refer to our Terms & Privacy.