Gathering detailed insights and metrics for oclif
Gathering detailed insights and metrics for oclif
CLI for generating, building, and releasing oclif CLIs. Built by Salesforce.
npm install oclif
Typescript
Module System
Min. Node Version
Node Version
NPM Version
68.8
Supply Chain
88.8
Quality
97.3
Maintenance
100
Vulnerability
98.6
License
TypeScript (95.22%)
EJS (4.33%)
JavaScript (0.42%)
Batchfile (0.03%)
Total Downloads
16,251,851
Last Day
25,444
Last Week
123,194
Last Month
432,090
Last Year
7,027,981
9,089 Stars
2,290 Commits
320 Forks
66 Watching
6 Branches
73 Contributors
Minified
Minified + Gzipped
Latest Version
4.17.17
Package Id
oclif@4.17.17
Unpacked Size
270.55 kB
Size
55.43 kB
File Count
105
NPM Version
10.9.0
Node Version
22.12.0
Publised On
21 Jan 2025
Cumulative downloads
Total Downloads
Last day
18.1%
25,444
Compared to previous day
Last week
1.4%
123,194
Compared to previous week
Last month
-16.7%
432,090
Compared to previous month
Last year
39.5%
7,027,981
Compared to previous year
24
34
oclif
CLIoclif
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:hook
oclif command
is now oclif generate:command
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
Creating a CLI:
1$ npx oclif generate mynewcli 2? npm package name (mynewcli): mynewcli 3$ cd mynewcli 4$ ./bin/run.js --version 5mynewcli/0.0.0 darwin-x64 node-v9.5.0 6$ ./bin/run.js --help 7USAGE 8 $ mynewcli [COMMAND] 9 10COMMANDS 11 hello 12 help display help for mynewcli 13 14$ ./bin/run.js hello world 15hello 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.
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
0 existing vulnerabilities detected
Reason
Found 1/8 approved changesets -- score normalized to 1
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
project is not fuzzed
Details
Reason
security policy file not detected
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2025-01-13
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More