2022-01-19 20:14:09 +00:00
|
|
|
# truetool
|
|
|
|
|
A easy tool for frequently used TrueNAS SCALE CLI utilities.
|
|
|
|
|
Previously known as "trueupdate"
|
2022-01-16 15:15:58 +00:00
|
|
|
|
|
|
|
|
## How to install
|
|
|
|
|
|
2022-01-19 20:14:09 +00:00
|
|
|
run `pip install truetool`
|
2022-01-16 15:15:58 +00:00
|
|
|
|
|
|
|
|
Please be aware you will need to reinstall after every SCALE update
|
|
|
|
|
|
|
|
|
|
## How to Update
|
|
|
|
|
|
2022-01-19 20:14:09 +00:00
|
|
|
run `pip install --upgrade truetool`
|
2022-01-16 15:15:58 +00:00
|
|
|
|
|
|
|
|
## How to use
|
|
|
|
|
|
2022-01-19 21:15:29 +00:00
|
|
|
running `truetool` should be a good start.
|
2022-01-16 15:15:58 +00:00
|
|
|
|
|
|
|
|
Additional options are available:
|
|
|
|
|
|
2022-01-19 21:15:29 +00:00
|
|
|
##### Help
|
|
|
|
|
|
|
|
|
|
- `truetool -h` for the CLI help page
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
##### Update
|
|
|
|
|
|
|
|
|
|
- `truetool -u` or ` truetool --update` update TrueNAS SCALE Apps
|
|
|
|
|
|
|
|
|
|
|
2022-01-19 20:14:09 +00:00
|
|
|
- `truetool --catalog CATALOGNAME` where CATALOGNAME is the name of the catalog you want to process in caps
|
|
|
|
|
- `truetool --versioning SCHEME` where SCHEME is the highest semver version you want to process. options: `patch`, `minor` and `major`
|
2022-01-19 21:15:29 +00:00
|
|
|
- `truetool -a` or ` truetool --all` updates both active (running) and non-active (stuck or stopped) Apps
|
2022-01-19 20:00:14 +00:00
|
|
|
|
|
|
|
|
|
2022-01-19 21:15:29 +00:00
|
|
|
#### Backup
|
|
|
|
|
- `truetool -b` or ` truetool --backup` backup the complete Apps system prior to updates
|
|
|
|
|
- `truetool -r` or ` truetool --restore` restores a specific backup by name
|
|
|
|
|
|
|
|
|
|
#### Other
|
|
|
|
|
|
|
|
|
|
- `truetool -s` or ` truetool --sync` to sync the catalogs before running updates
|
|
|
|
|
- `truetool -p` or ` truetool --prune` to prune (remove) old docker images after running auto-update
|
