Skip to content

Repository files navigation

@oclif/plugin-update

VersionDownloads/weekLicense

Usage

See https://oclif.io/docs/releasing.html#autoupdater

Configuration

Update Check Interval

You can customize how often the plugin checks for updates by adding the autoupdate.debounce configuration to your package.json:

{
"oclif": {
"update": {
"autoupdate": {
"debounce": 7
}
}
}
}

The debounce value is the number of days between update checks for all channels. When set, it overrides the default behavior for all channels.

If not configured, the plugin defaults to:

  • Stable channel: 14 days
  • Other channels: 1 day

Commands

oclif-example update [CHANNEL]

update the oclif-example CLI

USAGE
$ oclif-example update [CHANNEL] [--force | | [-a | -v <value> | -i]] [-b ]
FLAGS
-a, --available See available versions.
-b, --verbose Show more details about the available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the oclif-example CLI
EXAMPLES
Update to the stable channel:
$ oclif-example update stable
Update to a specific version:
$ oclif-example update --version 1.0.0
Interactively select version:
$ oclif-example update --interactive
See available versions:
$ oclif-example update --available

See code: src/commands/update.ts

Contributing

See contributing guide

About

add autoupdate to your oclif CLI

Resources

Code of conduct

Stars

58 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages