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 100,773 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 5 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
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.