+0
Daily
9,613
stars
363
forks
66
watchers
1,494
prs
557
issues
822
releases
README
oclif CLI - oclif CLI - 🗒 Description - 🚀 Getting Started Tutorial - 📌 Requirements - 📌 Migrating from V1 - 🏗 Usage - 📚 Examples - 🔨 Commands - Command Topics - 🚀 Contributing - 🏭 Related Repositories - 🦔 Learn More 🗒 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: sh-session $ 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 - Hello-World - Salesforce CLI - Heroku CLI 🔨 Commands Command Topics - oclif generate - Generate a new CLI - oclif help - Display help for oclif. - oclif init - Initialize a new oclif CLI - oclif 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. 🚀 Contributing See the contributing guide. 🏭 Related Repositories - @oclif/core
Top issues
#1219Not all package managers are respected9 comments · 2023-12-14#1985Allow explicit esm/cjs flag with "explicit" loader8 comments · 2026-02-26#828Allow configuring the tarball path & filename templates7 comments · 2022-02-12#1996pack macos: uninstall script bakes builder's $HOME into paths instead of resolving at install time4 comments · 2026-03-14#1624Add option to create new project with bun3 comments · 2024-11-29#1492[Feature Idea] Plugin for automatic interactive prompts for flags and args3 comments · 2024-07-23#968Package with Deno3 comments · 2022-09-26#1228Bug: `pack:win` fails (silently) when node_modules path is >260 characters2 comments · 2023-12-29
Discussions
#1951I'm curious about how release and publish actually work.1 comments · 2026-01-14#1930How to tests DEBUG mode0 comments · 2025-12-12#1858Update with pack:win0 comments · 2025-09-01#1825Wanting recommendations on an oclif cli interfacing with an existing Ruby CLI1 comments · 2025-07-23#1806Help defining opencli standard and create @oclif/plugin-opencli plugin1 comments · 2025-07-08#1798Adding man pages to installers1 comments · 2025-07-03#1797How to uninstall CLI installed through MacOS `.pkg`1 comments · 2025-07-03#1796Plugin: Support for generic Model Context Protocol (MCP) commands auto discovery.4 comments · 2025-06-28
Latest release
6.0.15 6.0.15 2026-10-26Bug Fixes deps: bump @aws-sdk/client-cloudfront from 3.1147.0 to 3.1155.0 (685bb1e)