DISNIX-RUN-ACTIVITY(1)

📦 version 0.10.2, in nixos 26.05, nixpkgs unstable

💅 disnix-run-activity — the disnix manual, page 1, bestie edition

okay so real talk, this whole page is about disnix-run-activity, and if you're the kind of person who lives in a terminal at 2am (me), you already know this is gonna be cute AND useful. let's get into it 🎀

✨ NAME ✨

disnix-run-activity — directly executes a Disnix deployment activity. yes, directly. no middleman, no extra steps, just straight in there. main character energy fr 💅

🌸 SYNOPSIS 🌸

disnix-run-activity [OPTION] operation

🦋 DESCRIPTION 🦋

the command disnix-run-activity gives you direct access to any deployment activity that Disnix carries out on a target machine. like, every single one. it's giving backstage pass energy 🎟️✨

👑 OPTIONS 👑

🧚 Operations:

  • --import — imports a given closure into the Nix store of the target machine. putting stuff where it belongs, love that for you 📦
  • --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. the haters, essentially 🙈
  • -r, --realise — realises the given store derivation on the target machine. yes it's spelled "realise", don't come for me, that's literally the flag 💀
  • --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. a full roster, if you will 👑
  • --query-requisites — queries all the requisites (intra-dependencies) of the given services on the target machine
  • --collect-garbage — collects garbage on the given target machine. digital spring cleaning, we love to see it 🧹
  • --activate — activates the given service on the target machine
  • --deactivate — deactivates the given service on the target machine. bye bestie 😭
  • --lock — acquires a lock on a Disnix profile of the target machine
  • --unlock — releases 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 to absolute paths. glow-up for your 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
  • --shell — spawns a Dysnomia shell to run arbitrary maintenance tasks. go off, do your little maintenance errands 🐚
  • --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. important: this property is ignored by this client because it only supports loopback connections. so like… it's there, but it's not doing anything for you 🙈

🍓 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
ngl the original wording is "must transferred" and I'm keeping it exactly as-is because I do not fix manpages, I only make them slay 💀

🎀 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/Shell 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.

🐚 Shell options:

  • --command=COMMAND — commands to execute in the shell session

💜 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
yes -C/--container and -c/--component show up twice on this page — once for the query options and once for clean snapshots. that's literally how it is, don't @ me 🫶

🌟 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, you ate that 💅✨

sign-off time: this is disnix version 0.10.2, dated January 1980 (iconic date, no notes), and it's DISNIX-RUN-ACTIVITY(1) if you need to cite your sources 🎀🫶

📦 where this page comes from