Oclif NPM | npm.io

`oclif` CLI

🗒 Description

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

🚀 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

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 - Base library for oclif. This can be used directly without the generator.
@oclif/test - Test helper for oclif.

🦔 Learn More

oclif

@stackmate/cli @dxos/cli balena-cli waque-plus awepat moovi moovii phishtory platformkit-generator @magister_zito/notes awtrix-hd @hlacannon/aws-public-ip-detector @hlacannon/aws-ec2-profiles dbdocs-with-ci @avrora/avb @avrora/avs @infinitebrahmanuniverse/nolb-ocl @everything-registry/sub-chunk-2368 @roomservice/benchpress sfdx_metadatas_filtering @safeguards/safeguards @ryanwersal/litra-cli simple-artifact-builder ribxzcli pocketpool redm-server-manager @schalltech/honeycomb-cli sql-schema-control sql-schema-generator sql-code-generator sql-dao-generator sonia-auv-cli @senses-mirror/senses-cli @trifinlabs/ramp-api s4-shell-tools schema-control @qn-pandora/pandora-tools schema-generator stsbroker @sotatek-tanhoang/cli @swell/cli @thepowereco/cli @switchboard-xyz/cli espolice epubinator dynamodb-dao-generator genealogit geis-cli mre liblab l-work graf-cli iconik instant8080 jerry-cli katacoda-cli k-react-cm google-sheet-cli nextrate @fluid-tools/build-cli npmzulu pi-gen platformkit aws-sleek-transformer azgo @asyncapi/cli @awtrix/dev waqueplus @vue-storefront/cli agg-generator weather-in-terminal @zalastax/nolb-ocl @uladkasach/schema-generator addons-transformer-for-amazon-eks @guardian/cfn-cli @hackmd/hackmd-cli @haribodev/aws-ec2-profiles @hesketh-racing/leapp-cli d3-fluid @deepgram/cli @devitools/cli @brevity-builder/cli whennessy-todocli wsncat wxcc dependencies-cli deploy-beta declapract @identity.com/solana-gatekeeper-cli @identity.com/gateway-usage xcl @chat-bot/cli @civic/token-guard create-saas-boilerplate chakra-cli cligoogle @conduitplatform/cli @cutelab/wavegen @credenceanalytics/fundscli codelogs

3 days ago

7 days ago

7 days ago

7 days ago

13 days ago

14 days ago

14 days ago

16 days ago

16 days ago

18 days ago

19 days ago

21 days ago

24 days ago

28 days ago

28 days ago

28 days ago

28 days ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

7 months ago

7 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

9 months ago

9 months ago

9 months ago

11 months ago

9 months ago

9 months ago

9 months ago

9 months ago

12 months ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

1 year ago

1 year ago

2 years ago

1 year ago

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

oclif CLI

🗒 Description

🚀 Getting Started Tutorial

📌 Requirements

📌 Migrating from V1

Breaking Changes

New Commands

🏗 Usage

📚 Examples

🔨 Commands

Command Topics

🚀 Contributing

🏭 Related Repositories

🦔 Learn More

`oclif` CLI