https://github.com/oclif/plugin-update
add autoupdate to your oclif CLI
https://github.com/oclif/plugin-update
Last synced: 3 months ago
JSON representation
add autoupdate to your oclif CLI
- Host: GitHub
- URL: https://github.com/oclif/plugin-update
- Owner: oclif
- License: mit
- Created: 2018-02-13T06:01:41.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2026-04-12T12:01:07.000Z (3 months ago)
- Last Synced: 2026-04-12T14:07:42.147Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 5.08 MB
- Stars: 56
- Watchers: 1
- Forks: 30
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# @oclif/plugin-update
[](https://npmjs.org/package/@oclif/plugin-update)
[](https://npmjs.org/package/@oclif/plugin-update)
[](https://github.com/oclif/plugin-update/blob/main/package.json)
- [@oclif/plugin-update](#oclifplugin-update)
- [Usage](#usage)
- [Commands](#commands)
- [Contributing](#contributing)
# 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`:
```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]`](#oclif-example-update-channel)
## `oclif-example update [CHANNEL]`
update the oclif-example CLI
```
USAGE
$ oclif-example update [CHANNEL] [--force | | [-a | -v | -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= 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](https://github.com/oclif/plugin-update/blob/4.7.33/src/commands/update.ts)_
# Contributing
See [contributing guide](./CONRTIBUTING.md)