npmpackage.info

Gathering detailed insights and metrics for @oclif/core

Other packages similar to @oclif/core

@oclif/plugin-test-core-v3

0.1.64

Test plugin that uses @oclif/core v3

oclif-core-rc

16.6.7

base library for oclif CLIs

@typhonjs-oclif/core

0.0.22

Provides TyphonJS extensions to building ESM Oclif V2 CLIs.

@oclif/plugin-test-core-v1

0.2.15

Test plugin that uses @oclif/core v1

Gathering detailed insights and metrics for @oclif/core

@oclif/core - 4.5.1 | npmpackage.info

@oclif/core

Node.js Open CLI Framework. Built by Salesforce.

4.5.1

246

MIT

TypeScript

398.19 kB

Installations

npm install @oclif/core

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=18.0.0

Node Version

22.17.0

NPM Version

10.9.2 Pull Requests

Open

2

Total

1,203

Closed

351

Merged

850

Issues

Open

17

Total

195

Closed

178

Releases

425

4.5.1

Updated on Jul 14, 2025

4.5.0

Updated on Jul 07, 2025

4.4.1

Updated on Jul 03, 2025

4.4.0

Updated on Jun 17, 2025

4.3.3

Updated on Jun 09, 2025

4.3.2

Updated on Jun 06, 2025

View All 425 releases

Languages

TypeScript

JavaScript

TypeScript (99.14%)

JavaScript (0.86%)

Developer

oclif

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

246 Stars

1,669 Commits

78 Forks

6 Watchers

9 Branches

64 Contributors

Updated on Jul 15, 2025

Maintainers

View All 64 Contributors

Package Meta Information

Latest Version

4.5.1

Package Id

@oclif/core@4.5.1

Unpacked Size

398.19 kB

Size

99.41 kB

File Count

161

NPM Version

10.9.2

Node Version

22.17.0

Published on

Jul 14, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

oclif: Node.JS Open CLI Framework

🗒 Description

This is a framework for building CLIs in Node.js. This framework was built out of the Salesforce CLI but generalized to build any custom CLI. It's designed both for single-file CLIs with a few flag options (like cat or ls), or for very complex CLIs that have subcommands (like git or heroku).

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.

✨ Features

Flag/Argument parsing - No CLI framework would be complete without a flag parser. We've built a custom one from years of experimentation that we feel consistently handles user input flexible enough for the user to be able to use the CLI in ways they expect, but without compromising strictness guarantees to the developer.
Super Speed - The overhead for running an oclif CLI command is almost nothing. It requires very few dependencies (only 28 dependencies in a minimal setup—including all transitive dependencies). Also, only the command to be executed will be required with node. So large CLIs with many commands will load equally as fast as a small one with a single command.
CLI Generator - Run a single command to scaffold out a fully functional CLI and get started quickly. See Getting Started Tutorial.
Testing Helpers - We've put a lot of work into making commands easier to test and mock out stdout/stderr. The generator will automatically create scaffolded tests.
Auto-documentation - By default you can pass --help to the CLI to get help such as flag options and argument information. This information is also automatically placed in the README whenever the npm package of the CLI is published. See the hello-world CLI example
Plugins - Using plugins, users of the CLI can extend it with new functionality, a CLI can be split into modular components, and functionality can be shared amongst multiple CLIs. See Building your own plugin.
Hooks - Use lifecycle hooks to run functionality any time a CLI starts, or on custom triggers. Use this whenever custom functionality needs to be shared between various components of the CLI.
TypeScript - Everything in the core of oclif is written in TypeScript and the generator will build fully configured TypeScript CLIs. If you use plugins support, the CLI will automatically use ts-node to run the plugins enabling you to use TypeScript with minimal-to-no boilerplate needed for any oclif CLI.
Auto-updating Installers - oclif can package your CLI into different installers that will not require the user to already have node installed on the machine. These can be made auto-updatable by using plugin-update.
Everything is Customizable - Pretty much anything can be swapped out and replaced inside oclif if needed—including the arg/flag parser.
Autocomplete - Automatically include autocomplete for your CLI. This includes not only command names and flag names, but flag values as well. For example, it's possible to configure the Heroku CLI to have completions for Heroku app names:

$ heroku info --app=<tab><tab> # will complete with all the Heroku apps a user has in their account

📌 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

See the v3 migration guide for an overview of breaking changes that occurred between v2 and v3.

See the v2 migration guide for an overview of breaking changes that occurred between v1 and v2.

Migrating from @oclif/config and @oclif/command? See the v1 migration guide.

📌 Documentation

The official oclif website, oclif.io, contains all the documentation you need for developing a CLI with oclif.

If there's anything you'd like to see in the documentation, please submit an issue on the oclif.github.io repo.

🚀 Standalone Usage

We strongly encourage you generate an oclif CLI using the oclif cli. The generator will generate an npm package with @oclif/core as a dependency.

You can, however, use @oclif/core in a standalone script like this:

1#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
2
3import * as fs from 'fs'
4import {Command, Flags, flush, handle} from '@oclif/core'
5
6class LS extends Command {
7  static description = 'List the files in a directory.'
8  static flags = {
9    version: Flags.version(),
10    help: Flags.help(),
11    dir: Flags.string({
12      char: 'd',
13      default: process.cwd(),
14    }),
15  }
16
17  async run() {
18    const {flags} = await this.parse(LS)
19    const files = fs.readdirSync(flags.dir)
20    for (const f of files) {
21      this.log(f)
22    }
23  }
24}
25
26LS.run(process.argv.slice(2), {
27  root: import.meta.dirname,
28  // Tell oclif what the contents of the package.json are.
29  // You could also set these in your package.json but specifying
30  // them here is useful if you're attempting to bundle your CLI
31  // without a package.json
32  pjson: {
33    name: 'ls',
34    version: '0.0.1',
35    oclif: {
36      // Tell oclif that this is a single command CLI
37      // See: https://oclif.io/docs/command_discovery_strategies
38      commands: {
39        strategy: 'single',
40        target: 'index.js',
41      },
42    },
43  },
44}).then(
45  async () => {
46    await flush()
47  },
48  async (err) => {
49    await handle(err)
50  },
51)

Then run it like this:

1$ ts-node myscript.ts
2...files in current dir...

You can also use oclif's Parser separately:

1// index.js
2import {Args, Flags, Parser} from '@oclif/core'
3
4const {args, flags} = await Parser.parse(process.argv.slice(2), {
5  args: {
6    name: Args.string({required: true}),
7  },
8  flags: {
9    from: Flags.string({char: 'f', default: 'oclif'}),
10  },
11})
12
13console.log(`hello ${args.name} from ${flags.from}`)

$ node index.js world --from oclif

hello world from oclif

NOTE If you're using the Parser class, you will not be able to use the builtin help and version flags since those require the context of an oclif project.

🚀 Contributing

See the contributing guide.

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.

2

Code-Review

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

0

CII-Best-Practices

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

0

Token-Permissions

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

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/automerge.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/automerge.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/create-github-release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/create-github-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/external-test.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/external-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/external-test.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/external-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/external-test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/external-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/external-test.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/external-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/failureNotifications.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/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/core/notify-slack-on-pr-open.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/onRelease.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/onRelease.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/onRelease.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/onRelease.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/onRelease.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/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/core/stale.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:110: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:111: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:116: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:119: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:124: update your workflow using https://app.stepsecurity.io/secureworkflow/oclif/core/test.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:119
Info: 0 out of 11 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 15 third-party GitHubAction dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4

/10

Last Scanned on 2025-07-07

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

Other packages similar to @oclif/core

Other packages similar to @oclif/core

@oclif/core

Installations

Developer Guide

Yes

ESM

>=18.0.0

22.17.0

10.9.2

Pull Requests

2

1,203

351

850

Issues

17

195

178

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

oclif: Node.JS Open CLI Framework

🗒 Description

🚀 Getting Started Tutorial

✨ Features

📌 Requirements

📌 Migrating

📌 Documentation

🚀 Standalone Usage

10

10

10

10

2

0

0

0

0

0

0

0

4

/10