nvrs
fast new version checker for software releases
documentation for bleeding-edge main can be found at https://nvrs.adamperkowski.dev/main
keep in mind that this website is still a WIP
copyright
MIT License
Copyright (c) 2025 Adam Perkowski
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
features
nvchecker compatibility
check the release notes and configuration docs for compatibility updates and instructions
speed
| command | time per updated package | details |
|---|---|---|
nvrs | ~ 0.03s | API requests included depends on internet speed |
nvrs --cmp | ~ 0.0008s | depends on disk speed |
nvrs --take | ~ 0.001s | depends on disk speed |
sources
see the project's readme for a list of supported sources
installation
Arch Linux
nvrs is available as a package in the AUR.
you can install it with your preferred AUR helper, example:
paru -S nvrs
or manually:
git clone https://aur.archlinux.org/nvrs.git
cd nvrs
makepkg -si
Cargo
nvrs can be installed via Cargo with:
cargo install nvrs --all-features
note that crates installed using cargo install require manual updating with cargo install --force.
Manual
- download the latest binary from GitHub's release page
- allow execution
chmod +x nvrs
- move the file to a directory in
$PATH(using/usr/binas an example)
sudo mv nvrs /usr/bin/nvrs
configuration
nvrs relies on a TOML configuration file (example) containing basic settings, such as oldver, newver & keyfile paths, as well as package entries. supported config paths:
$XDG_CONFIG_HOME/nvrs.toml(~/.config/nvrs.tomlif the variable is not set)./nvrs.toml- custom paths set with
nvrs --config
__config__ table
this configures the behavior of nvrs. see the example config.
available fields:
| name | description | type | required |
|---|---|---|---|
oldver | path to the oldver file | string | ✔️ |
newver | path to the newver file | string | ✔️ |
keyfile | path to a keyfile (see keyfile structure) | string | ❌ |
package entries
package entries are custom entries in the main config file. they contain values such as:
| name | description | type | required | custom |
|---|---|---|---|---|
source | see sources | string | ✔️ | ❌ |
| source name | the "target". eg. repo path for github | string | ✔️ | ✔️ |
host | domain name the source is hosted on | string | ❌ | ❌ |
prefix | the prefix used in releases / tags example: v for tags like v0.1.0 | string | ❌ | ❌ |
use_max_tag | use max git tag instead of the latest release | bool | ❌ | ❌ |
url | url to check for source type regex | string | ❌ | ❌ |
regex | regex to search url for source type regex | bool | ❌ | ❌ |
keyfile structure
this file contains API keys for various sources. example can be found here.
[keys]
github = "your_secret_github_api_key_that_you_shouldnt_push_to_a_public_nor_a_private_remote_repo_because_there_will_definitely_be_serious_consequences_sooner_or_later_if_you_do_trust_me_just_dont"
gitlab = "remember_to_replace_the_example_values_here_here_with_your_actual_keys_otherwise_it_wont_work_but_dont_push_keyfiles_to_remote_repos"
"I think that example value is not long enough" - orhun