nurl/README.md

# nurl

[![release](https://img.shields.io/github/v/release/nix-community/nurl?logo=github&style=flat-square)](https://github.com/nix-community/nurl/releases)
[![version](https://img.shields.io/crates/v/nurl?logo=rust&style=flat-square)][crate]
[![deps](https://deps.rs/repo/github/nix-community/nurl/status.svg?style=flat-square&compact=true)](https://deps.rs/repo/github/nix-community/nurl)
[![license](https://img.shields.io/badge/license-MPL--2.0-blue?style=flat-square)](https://www.mozilla.org/en-US/MPL/2.0)
[![ci](https://img.shields.io/github/actions/workflow/status/nix-community/nurl/ci.yml?label=ci&logo=github-actions&style=flat-square)](https://github.com/nix-community/nurl/actions?query=workflow:ci)

Generate Nix fetcher calls from repository URLs


## Installation

The latest precompiled binaries are available on [github](https://github.com/nix-community/nurl/releases/latest).

Alternatively you can install nurl from [crates.io][crate] with cargo.

```sh
cargo install nurl
```


## Building from source

```sh
cargo build --release
```


## Usage

```
Generate Nix fetcher calls from repository URLs
https://github.com/nix-community/nurl

Usage: nurl [OPTIONS] <URL> <REV>

Arguments:
  <URL>  URL to the repository to be fetched
  <REV>  the revision or reference to be fetched

Options:
  -f, --fetcher <FETCHER>  specify the fetcher function instead of inferring from the URL [possible values: fetchFromGitHub, fetchFromGitLab, fetchFromSourcehut, fetchgit, fetchhg]
  -i, --indent <INDENT>    extra indentation (in number of spaces) [default: 0]
  -h, --help               Print help information
  -V, --version            Print version information
```


## Changelog
See [CHANGELOG.md](CHANGELOG.md)


[crate]: https://crates.io/crates/nurl