@oclif/plugin-warn-if-update-available

What is @oclif/plugin-warn-if-update-available?

@oclif/plugin-warn-if-update-available is a plugin for the Oclif CLI framework that checks for updates to the CLI tool and warns the user if an update is available. This helps ensure that users are always aware of the latest version and can benefit from new features, bug fixes, and security patches.

What are @oclif/plugin-warn-if-update-available's main functionalities?

Check for Updates

This feature checks if there is an update available for the CLI tool and warns the user if an update is found. The code sample demonstrates how to integrate this functionality into an Oclif command.

const { Command } = require('@oclif/command');
const { warnIfUpdateAvailable } = require('@oclif/plugin-warn-if-update-available');

class MyCommand extends Command {
  async run() {
    await warnIfUpdateAvailable(this.config);
    this.log('Hello, world!');
  }
}

MyCommand.run();

Other packages similar to @oclif/plugin-warn-if-update-available

update-notifier

update-notifier is a package that checks for updates of a given npm package and notifies the user if an update is available. It is similar to @oclif/plugin-warn-if-update-available but can be used with any Node.js application, not just Oclif-based CLIs.

npm-check-updates

npm-check-updates is a tool that allows you to find and update outdated npm dependencies in your project. While it is more focused on updating dependencies rather than notifying users of CLI updates, it provides similar functionality in terms of keeping software up-to-date.

README

@oclif/plugin-warn-if-update-available

warns if there is a newer version of CLI released

• Usage
• Commands

Usage

$ npm install -g @oclif/plugin-warn-if-update-available
$ oclif-example COMMAND
running command...
$ oclif-example (-v|--version|version)
@oclif/plugin-warn-if-update-available/0.0.0 darwin-x64 node-v9.9.0
$ oclif-example --help [COMMAND]
USAGE
  $ oclif-example COMMAND
...

Commands

• oclif-example hello [FILE]

oclif-example hello [FILE]

describe the command here

USAGE
  $ oclif-example hello [FILE]

OPTIONS
  -f, --force
  -n, --name=name  name to print

EXAMPLE
  $ oclif-example hello
  hello world from ./src/hello.ts!

See code: src/commands/hello.ts