npmpackage.info

Gathering detailed insights and metrics for oclif

Other packages similar to oclif

@oclif/config

1.18.17

base config object and standard interfaces for oclif components

@oclif/command

1.8.36

oclif base command

@oclif/core

4.2.4

base library for oclif CLIs

@oclif/errors

1.3.6

display friendly CLI errors and log to error log

oclif

CLI for generating, building, and releasing oclif CLIs. Built by Salesforce.

4.17.17

9,089

MIT

TypeScript

238.00 B

16,251,851 4.9

Installations

npm install oclif

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=18.0.0

Node Version

22.12.0

NPM Version

10.9.0 Score

68.8

Supply Chain

88.8

Quality

97.3

Maintenance

100

Vulnerability

98.6

License

Pull Requests

Open

2

Total

1,077

Closed

363

Merged

712

Issues

Open

12

Total

541

Closed

529

Releases

622

4.17.17

Published on 21 Jan 2025

4.17.17-dev.0

Published on 20 Jan 2025

4.17.16

Published on 20 Jan 2025

4.17.15

Published on 19 Jan 2025

4.17.14

Published on 19 Jan 2025

4.17.13

Published on 14 Jan 2025

View all 622 releases

Contributors

View all 73 contributors

Languages

TypeScript

EJS

JavaScript

Batchfile

TypeScript (95.22%)

EJS (4.33%)

JavaScript (0.42%)

Batchfile (0.03%)

Developer

oclif

Download Statistics

Total Downloads

16,251,851

Last Day

25,444

Last Week

123,194

Last Month

432,090

Last Year

7,027,981

GitHub Statistics

9,089 Stars

2,290 Commits

320 Forks

66 Watching

6 Branches

73 Contributors

Bundle Size

340.00 B

Minified

238.00 B

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

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

Total Downloads

Cumulative downloads

Total Downloads

16,251,851

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

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Versions

`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:

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)

📚 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

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/failureNotifications.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/failureNotifications.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/notify-slack-on-pr-open.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/notify-slack-on-pr-open.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/onRelease.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/onRelease.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/onRelease.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/onRelease.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/stale.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:114: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:120: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:185: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:186: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:190: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:75: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:136: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:137: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:141: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:161: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:162: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:166: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/oclif/test.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:120
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:91
Info: 0 out of 16 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 12 third-party GitHubAction dependencies pinned
Info: 0 out of 2 npmCommand dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

4.9

/10

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