flake-edit(1)

📦
version 0.4.0 · 2 versions
, in nixpkgs unstable

💅 flake-edit — bestie, we're editing flake inputs and it's giving ✨effortless✨

Sooo this is the flake-edit(1) manual page from the General Commands Manual, and honestly? It's a whole vibe. You get to edit your flake inputs with ease — that's literally the entire pitch, and it ate. 🍓

🦋 NAME 🦋

flake-edit — edit your flake inputs with ease, no cap 💖

🌸 SYNOPSIS 🌸

flake-edit [--flake] [--lock-file] [--diff] [--no-lock]
[--non-interactive] [--no-cache] [--cache] [--config] [-h|--help]
[-V|--version] <subcommands>

Like, that's the whole shape of it — global flags, then a subcommand, periodt. 🎀

✨ DESCRIPTION ✨

Edit your flake inputs with ease.

That's it. That's the description. Short queen behavior, we respect it. 👑

💜 OPTIONS 💜

Okay so here are all the flags, and there are a lot, and every single one matters, so buckle up bestie:

  • --flake <FLAKE> — the path to your flake.nix, or a directory that contains a flake.nix. Defaults to flake.nix in the current directory. 🗂️
  • --lock-file <LOCK_FILE> — where your flake.lock lives. Defaults to flake.lock in the current directory. Defaults are life fr fr.
  • --diff — prints a diff of the changes instead of writing them to disk. Preview mode, iconic, no regrets. 👀
  • --no-lock — skips updating the lockfile after editing flake.nix. Sometimes you just don't wanna, and that's valid.
  • --non-interactive — disables interactive prompts. For when you want zero conversation, only results.
  • --no-cache — disables reading from and writing to the completion cache. Boundaries, honestly. 🚫
  • --cache <CACHE> — path to a custom cache file, if you're fancy like that.
  • --config <CONFIG> — path to a custom configuration file. Your config, your rules. 💅
  • -h, --help — prints help (and heads up: it says to see a summary with -h). Cute of it.
  • -V, --version — prints version. Obviously. ⭐

🌈 SUBCOMMANDS 🌈

Here's the whole crew — each one has its own manual page, iykyk:

  • flake-edit-add(1) — add a new flake reference 🎀
  • flake-edit-remove(1) — remove a specific flake reference based on its id
  • flake-edit-change(1) — change an existing flake reference's URI
  • flake-edit-list(1) — list flake inputs 📋
  • flake-edit-update(1) — update inputs to their latest specified release 🔥
  • flake-edit-pin(1) — pin inputs to their current or a specified rev 📌
  • flake-edit-unpin(1) — unpin an input so it tracks the upstream default again
  • flake-edit-toggle(1) — toggle an input between its active url and a stored alternate 🔄
  • flake-edit-follow(1) — automatically add and remove follows declarations
  • flake-edit-add-follow(1) — manually add a single follows declaration
  • flake-edit-config(1) — manage flake-edit configuration ⚙️
  • flake-edit-help(1) — print this message or the help of the given subcommand(s) 🫶

🧚 EXAMPLES 🧚

These are the moment, honestly. Screenshot them, memorize them, live them:

Add a new flake input:

flake-edit add nixpkgs github:NixOS/nixpkgs

Add an input with automatic ID inference:

flake-edit add github:nix-community/home-manager

Remove a flake input:

flake-edit remove nixpkgs

List all current inputs:

flake-edit list

Update all inputs to latest versions:

flake-edit update

Pin an input to its current revision:

flake-edit pin nixpkgs

Toggle an input between its active url and a stored alternate:

flake-edit toggle rust-overlay

Switch an input to a local checkout, storing the previous url as a commented alternate:

flake-edit toggle ../rust-overlay

Remove a stored variant's line and flip to the alternative first:

flake-edit toggle --remove ../rust-overlay

Preview changes without applying them:

flake-edit --diff add home-manager github:nix-community/home-manager

Add input without updating the lockfile:

flake-edit --no-lock add nixos-hardware github:NixOS/nixos-hardware

See? Every single one, preserved, untouched, slaying. 💯

👑 AUTHORS 👑

  • Alexander Kenji Berthold — the main character who made all this happen 🫶
Heads up bestie: those examples with --diff and --no-lock are the safe-preview combos — nothing wrong with peeking before you commit to a change. 🙈

<div align="center">✨ okay that's the whole page, tysm for reading ✨</div>

So like, this is flake-edit version 0.4.0 — the footer says flake-edit 0.4.0 - no_date - no_rev, and it's dated... nowhere, bestie, it's giving no_date and no_rev energy 😭. The source/version line signs off the page along with the flake-edit(1) manual reference, and we simply must mention it because it's part of the record. Byeee, go edit some inputs 💅🦋🌸

📦 where this page comes from