NIX-PREFETCH-GITHUB(1)

📦
version 7.1.0 · 3 versions
, in nixpkgs unstable

💅 NIX-PREFETCH-GITHUB(1) 💅

Okay bestie, welcome to the manual page for nix-prefetch-github — yes, that’s literally the manual name — and we’re on the NIX-PREFETCH-GITHUB(1) page, version 7.1.0. It’s giving “tool that generates nix arguments so you don’t have to suffer manually.” Let’s go. ✨

✨ NAME ✨

  • nix-prefetch-github — the nix-prefetch-github 7.1.0 page, periodt. 💖

🚀 NIX-PREFETCH-GITHUB 🚀

Use this program to generate the arguments for the fetchFromGitHub nix function. That’s the whole vibe. 🫶

usage: nix-prefetch-github [-h] [--fetch-submodules] [--no-fetch-submodules]
                           [--leave-dot-git] [--no-leave-dot-git]
                           [--deep-clone] [--no-deep-clone] [--verbose]
                           [--quiet] [--nix] [--json] [--meta] [--version]
                           [--rev REV]
                           owner repo

📍 Positional Arguments 📍

  • owner — first positional argument. The original page gives no extra description here, so we’re not inventing one. 💅
  • repo — second positional argument. Same deal: no extra description in the original. 🫶

🎛️ Named Arguments 🎛️

  • --fetch-submodules — include git submodules in the output derivation. Default: PrefetchOptions(fetch_submodules=False, deep_clone=False, leave_dot_git=False). 🧚
  • --no-fetch-submodules — don’t include git submodules in output derivation. 🚫
  • --leave-dot-git — include .git folder in output derivation. Use this if you need repository data, e.g. current commit hash, for the build process. 🔥
  • --no-leave-dot-git — don’t include .git folder in output derivation. 🙈
  • --deep-clone — include all of the repository history in the output derivation. This option implies --leave-dot-git. 👑
  • --no-deep-clone — don’t include the repository history in the output derivation. 💀
  • --verbose, -v — print additional information about the programs execution. This is useful if you want to issue a bug report. Default: LoggingConfiguration(output_file=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>, log_level=30). 🐛
  • --quiet, -q — print less information about the programs execution. 🤫
  • --nix — output the results as valid nix code. Default: RenderingFormat.json. 🌈
  • --json — output the results in the JSON format. ⭐
  • --meta — output the results in JSON format where the arguments to fetchFromGitHub are located under the src key of the resulting json dictionary and meta information about the prefetched repository is located under the meta key of the output. 🎀
  • --version — show program’s version number and exit. 👋
  • --rev — the original page lists this with no description, so we’re leaving it exactly that way. No invented lore. 🫶

📁 NIX-PREFETCH-GITHUB-DIRECTORY 📁

Use this program to generate a nix expression for fetchFromGitHub based on the git repository in the local directory. Local-directory main character energy. 🦋

usage: nix-prefetch-github-directory [-h] [--fetch-submodules]
                                     [--no-fetch-submodules] [--leave-dot-git]
                                     [--no-leave-dot-git] [--deep-clone]
                                     [--no-deep-clone] [--verbose] [--quiet]
                                     [--nix] [--json] [--meta] [--version]
                                     [--directory DIRECTORY] [--remote REMOTE]

🎛️ Named Arguments 🎛️

  • --fetch-submodules — include git submodules in the output derivation. Default: PrefetchOptions(fetch_submodules=False, deep_clone=False, leave_dot_git=False). 🧚
  • --no-fetch-submodules — don’t include git submodules in output derivation. 🚫
  • --leave-dot-git — include .git folder in output derivation. Use this if you need repository data, e.g. current commit hash, for the build process. 🔥
  • --no-leave-dot-git — don’t include .git folder in output derivation. 🙈
  • --deep-clone — include all of the repository history in the output derivation. This option implies --leave-dot-git. 👑
  • --no-deep-clone — don’t include the repository history in the output derivation. 💀
  • --verbose, -v — print additional information about the programs execution. This is useful if you want to issue a bug report. Default: LoggingConfiguration(output_file=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>, log_level=30). 🐛
  • --quiet, -q — print less information about the programs execution. 🤫
  • --nix — output the results as valid nix code. Default: RenderingFormat.json. 🌈
  • --json — output the results in the JSON format. ⭐
  • --meta — output the results in JSON format where the arguments to fetchFromGitHub are located under the src key of the resulting json dictionary and meta information about the prefetched repository is located under the meta key of the output. 🎀
  • --version — show program’s version number and exit. 👋
  • --directory — the original page lists this with no description, so no extra description from me. 💅
  • --remote — Default: 'origin'. 🧭

🏷️ NIX-PREFETCH-LATEST-RELEASE 🏷️

Use this program to generate a nix expression for the latest release of a github repository. Latest release, no cap. 🍓

usage: nix-prefetch-github-latest-release [-h] [--fetch-submodules]
                                          [--no-fetch-submodules]
                                          [--leave-dot-git]
                                          [--no-leave-dot-git] [--deep-clone]
                                          [--no-deep-clone] [--verbose]
                                          [--quiet] [--nix] [--json] [--meta]
                                          [--version]
                                          owner repo

📍 Positional Arguments 📍

  • owner — first positional argument. The original gives no description, so we’re keeping it cute and empty. 💖
  • repo — second positional argument. Same energy: no description in the original. 🫶

🎛️ Named Arguments 🎛️

  • --fetch-submodules — include git submodules in the output derivation. Default: PrefetchOptions(fetch_submodules=False, deep_clone=False, leave_dot_git=False). 🧚
  • --no-fetch-submodules — don’t include git submodules in output derivation. 🚫
  • --leave-dot-git — include .git folder in output derivation. Use this if you need repository data, e.g. current commit hash, for the build process. 🔥
  • --no-leave-dot-git — don’t include .git folder in output derivation. 🙈
  • --deep-clone — include all of the repository history in the output derivation. This option implies --leave-dot-git. 👑
  • --no-deep-clone — don’t include the repository history in the output derivation. 💀
  • --verbose, -v — print additional information about the programs execution. This is useful if you want to issue a bug report. Default: LoggingConfiguration(output_file=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>, log_level=30). 🐛
  • --quiet, -q — print less information about the programs execution. 🤫
  • --nix — output the results as valid nix code. Default: RenderingFormat.json. 🌈
  • --json — output the results in the JSON format. ⭐
  • --meta — output the results in JSON format where the arguments to fetchFromGitHub are located under the src key of the resulting json dictionary and meta information about the prefetched repository is located under the meta key of the output. 🎀
  • --version — show program’s version number and exit. 👋

🔑 GITHUB API TOKEN 🔑

All the commands provided by this package will read the environment variable GITHUB_TOKEN and use its content verbatim as an authentication/authorization token when requesting from GitHubs API. That’s the token vibe. 🔐

The different command line programs of this package provide different output formats. Those can be selected via different arguments provided to the program. ✨

🧾 JSON OUTPUT 🧾

The --json argument is the default and will render the output as JSON to the standard output of the program. The resulting json value will consist of a single dictionary where all key value pairs correspond to the arguments to the fetchFromGitHub function provided by nixpkgs. It is intended to be used directly in nix code:

src = with builtins; fetchFromGitHub (fromJSON (readFile ./nix-prefetch-github-output.json))

That’s literally the whole JSON moment. Clean, direct, iconic. 💅

🪄 META INFORMATION OUTPUT 🪄

The --meta argument produces output similar to the output produced by --json. The difference is that a nested dictionary is produced with two top level keys: src and meta. The src key will contain the same data as would have been yielded by --json whereas the meta key contains some meta data on the commit that was fetched. At the moment this will only be the date and time of day of the latest commit. This can be useful when providing nightly versions of a package:

let fetchedSourceCode = (fromJSON (readFile ./nix-prefetch-github-output.json));
in buildPackage {
  pname = "my-package";
  version = fetchedSourceCode.meta.commitDate;
  src = fetchFromGitHub fetchedSourceCode.src;
  ...
};

Nightly versions said “let me be metadata-coded.” 🌙

🧱 NIX OUTPUT 🧱

Consider this a legacy output format without any practical applications. The --nix argument will result in a valid nix expression produced by the respective program.

Legacy, yes. Still valid nix, yes. We don’t make the rules. 🫠

👑 Author 👑

Sebastian Jordan. Iconic author behavior. 💜

2022, Sebastian Jordan.

Byeee bestie! This was the NIX-PREFETCH-GITHUB(1) page from nix-prefetch-github 7.1.0, dated Jan 02, 1980 — mwah 💋✨

📦 where this page comes from