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

    1.7.3 • Public • Published

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

    warns if there is a newer version of CLI released

    Version CircleCI Appveyor CI Downloads/week License

    What is this?

    This plugin shows a warning message if a user is running an out of date CLI.

    screenshot

    How it works

    This checks the version against the npm registry asynchronously in a forked process, at most once per 7 days. It then saves a version file to the cache directory that will enable the warning. The upside of this method is that it won't block a user while they're using your CLI—the downside is that it will only display after running a command that fetches the new version.

    Installation

    Add the plugin to your project with yarn add @oclif/plugin-warn-if-update-available, then add it to the package.json of the oclif CLI:

    {
      "name": "mycli",
      "version": "0.0.0",
      // ...
      "oclif": {
        "plugins": ["@oclif/plugin-help", "@oclif/plugin-warn-if-update-available"]
      }
    }

    Configuration

    In package.json, set oclif['warn-if-update-available'] to an object with any of the following configuration properties:

    • timeoutInDays - Duration between update checks. Defaults to 60.
    • message - Customize update message.
    • registry - URL of registry. Defaults to the public npm registry: https://registry.npmjs.org
    • authorization - Authorization header value for registries that require auth.

    Example configuration

    {
      "oclif": {
        "plugins": [
          "@oclif/plugin-warn-if-update-available"
        ],
        "warn-if-update-available": {
          "timeoutInDays": 7,
          "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>.",
          "registry": "https://my.example.com/module/registry",
          "authorization": "Basic <SOME READ ONLY AUTH TOKEN>"
        }
      }
    }

    Keywords

    Install

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

    DownloadsWeekly Downloads

    447,925

    Version

    1.7.3

    License

    MIT

    Unpacked Size

    9.6 kB

    Total Files

    10

    Last publish

    Collaborators

    • rodesp
    • mdonnalley
    • rasphilco
    • dickeyxxx
    • amphro
    • chadian
    • salesforce-releases