os/doc/integrations/nvfetcher.md
Trevor Riles 804e972c57 Update docs and scripts to use main branch.
When following the getting started guide commands were failing due to
the mater branch not existing. I went through and updated all
references in the docs and other scripts from master to main.
2021-10-09 11:19:52 -05:00

1.4 KiB

nvfetcher

NvFetcher is a workflow companion for updating nix sources.

You can specify an origin source and an update configuration, and nvfetcher can for example track updates to a specific branch and automatically update your nix sources configuration on each run to the tip of that branch.

All package source declaration is done in sources.toml.

From within the devshell of this repo, run nvfetcher, a wrapped version of nvfetcher that knows where to find and place its files and commit the results.

Usage

Statically fetching (not tracking) a particular tag from a github repo:

[manix]
src.manual = "v0.6.3"
fetch.github = "mlvzk/manix"

Tracking the latest github release from a github repo:

[manix]
src.github = "mlvzk/manix" # responsible for tracking
fetch.github = "mlvzk/manix" # responsible for fetching

Tracking the latest commit of a git repository and fetch from a git repo:

[manix]
src.git = "https://github.com/mlvzk/manix.git" # responsible for tracking
fetch.git = "https://github.com/mlvzk/manix.git" # responsible for fetching
Note:

Please refer to the NvFetcher Readme for more options.