DISNIX-CLIENT(1)

📦 version 0.10.2, in nixos 26.05, nixpkgs unstable

💅 NAME

okay so disnix-client — it's the tool that gives you access to the disnix-service through the D-Bus system bus or session bus. bestie, that's literally the whole thing ✨

🎀 SYNOPSIS

disnix-client [OPTION] operation

🦋 DESCRIPTION

So disnix-client is your lil handshake with a disnix-service instance that's running on the same machine — it does that by connecting to the D-Bus system bus or session bus. no cap, that's it 💅

ngl, in most cases this tool is only needed for debugging purposes, because it literally only speaks the D-Bus protocol and it cannot connect to a remote machine. like, it's not built for that, periodt.

A way more useful client for production environments is disnix-ssh-client — that's the one you want when things get real 🫶

✨ OPTIONS ✨

🌸 Operations:

  • --import — Imports a given closure into the Nix store of the target machine 📦
  • --export — Exports the closure of a given Nix store path of the target machine into a file 💾
  • --print-invalid — Prints all the paths that are not valid in the Nix store of the target machine 🙈
  • -r, --realise — Realises the given store derivation on the target machine 🔥
  • --set — Creates a Disnix profile containing only the given derivation on the target machine 🎀
  • -q, --query-installed — Queries all the installed services on the given target machine 🔍
  • --query-requisites — Queries all the requisites (the intra-dependencies, iykyk) of the given services on the target machine 🧚
  • --collect-garbage — Collects garbage on the given target machine 🗑️
  • --activate — Activates the given service on the target machine ⚡
  • --deactivate — Deactivates the given service on the target machine 💤
  • --lock — Acquires a lock on a Disnix profile of the target machine 🔒
  • --unlock — Release the lock on a Disnix profile of the target machine 🔓
  • --snapshot — Snapshots the logical state of a component on the given target machine 📸
  • --restore — Restores the logical state of a component on the given target machine ⏪
  • --delete-state — Deletes the state of a component on the given machine 💀
  • --query-all-snapshots — Queries all available snapshots of a component on the given target machine 🌈
  • --query-latest-snapshot — Queries the latest snapshot of a component on the given target machine ⭐
  • --print-missing-snapshots — Prints the paths of all snapshots not present on the given target machine 🫥
  • --import-snapshots — Imports the specified snapshots into the remote snapshot store 📥
  • --export-snapshots — Exports the specified snapshot to the local snapshot store 📤
  • --resolve-snapshots — Converts the relative paths to the snapshots into absolute paths 🧭
  • --clean-snapshots — Removes older snapshots from the snapshot store 🧹
  • --capture-config — Captures the configuration of the machine from the Dysnomia container properties in a Nix expression 📝
  • --help — Shows the usage of this command to the user 💖
  • --version — Shows the version of this command to the user 👑

🌟 General options:

  • -t, --target=TARGET — Specifies the target to connect to. ⚠️ heads up: this property is ignored by this client because it only supports loopback connections. (yes bestie, it's a whole vibe check it just doesn't attend 🙈)
  • --session-bus — Connects to the session bus instead of the system bus. This is useful for testing/debugging purposes 🧪

🍓 Import/Export/Import snapshots/Export snapshots options:

  • --localfile — Specifies that the given paths are stored locally and must be transferred to the remote machine if needed 🏠
  • --remotefile — Specifies that the given paths are stored remotely and must transferred from the remote machine if needed 🌐

🐚 Shell options:

  • --command=COMMAND — Commands to execute in the shell session ⌨️

💜 Set/Query installed/Lock/Unlock options:

  • -p, --profile=PROFILE — Name of the Disnix profile. Defaults to: default 🎯

🗑️ Collect garbage options:

  • -d, --delete-old — Indicates whether all older generations of Nix profiles must be removed as well 🧼

⚡ Activation/Deactivation/Snapshot/Restore/Delete state options:

  • --type=TYPE — Specifies the activation module that should be used, such as echo or process. 🔧
  • --arguments=ARGUMENTS — Specifies the arguments passed to the Dysnomia module, which is a string with key=value pairs 📎
  • --container=CONTAINER — Name of the container in which the component is managed. If omitted it will default to the same value as the type. 🫙

📸 Query all snapshots/Query latest snapshot options:

  • -C, --container=CONTAINER — Name of the container in which the component is managed 🫙
  • -c, --component=COMPONENT — Name of the component hosted in a container 🧩

🧹 Clean snapshots options:

  • --keep=NUM — Amount of snapshot generations to keep. Defaults to: 1 🔢
  • -C, --container=CONTAINER — Name of the container to filter on 🫙
  • -c, --component=COMPONENT — Name of the component to filter on 🧩

🌈 ENVIRONMENT

  • DISNIX_PROFILE — Sets the name of the profile that stores the manifest on the coordinator machine and the deployed services per machine on each target (Defaults to: default). 🌸

Copyright © 2008-2022 Sander van der Burg

and that's the whole page, bestie 🫶 this was disnix 0.10.2, dated January 1980 — yeah, the date is iconic and a little unhinged, we don't question it 💅✨

📦 where this page comes from