Skip to content

Command-Line Help for wire

This document contains the help content for the wire command-line program.

Command Overview:

wire

a tool to deploy nixos systems

Usage: wire [OPTIONS] <COMMAND>

Subcommands:
  • apply — Deploy nodes
  • inspect — Inspect hive
Options:
  • -v, --verbose — Increase logging verbosity

  • -q, --quiet — Decrease logging verbosity

  • --path <PATH> [alias: flake] — Path or flake reference

    Default value: /build/doc

  • --no-progress — Hide progress bars.

    Defaults to true if stdin does not refer to a tty (unix pipelines, in CI).

    Default value: true

  • --non-interactive — Never accept user input.

    Defaults to true if stdin does not refer to a tty (unix pipelines, in CI).

    Default value: true

  • --show-trace — Show trace logs

    Default value: false

wire apply

Deploy nodes

Usage: wire apply [OPTIONS] [GOAL]

Arguments:
  • <GOAL>

    Default value: switch

    Possible values:

    • switch: Make the configuration the boot default and activate now
    • build: Build the configuration but do nothing with it
    • push: Copy system derivation to remote hosts
    • keys: Push deployment keys to remote hosts
    • boot: Activate system profile on next boot
    • test: Activate the configuration, but don't make it the boot default
    • dry-activate: Show what would be done if this configuration were activated
Options:
  • -o, --on <NODE | @TAG | -> — List of literal node names, a literal -, or @ prefixed tags.

    - will read additional values from stdin, separated by whitespace. Any - implies --non-interactive.

  • -p, --parallel <PARALLEL>

    Default value: 10

  • -n, --no-keys — Skip key uploads. noop when [GOAL] = Keys

    Default value: false

  • -a, --always-build-local <NODE> — Overrides deployment.buildOnTarget

  • -r, --reboot — Reboot the nodes after activation

    Default value: false

  • --handle-unreachable <HANDLE_UNREACHABLE> — How to handle an unreachable node in the ping step.

    This only effects the ping step. wire will still fail the node if it becomes unreachable after activation

    Default value: fail-node

    Possible values: ignore, fail-node

  • --ssh-accept-host — Unconditionally accept SSH host keys [!!]

    Sets StrictHostKeyChecking to no. Vulnerable to man-in-the-middle attacks, use with caution.

    Default value: false

wire inspect

Inspect hive

Usage: wire inspect [OPTIONS] [SELECTION]

Command Alias: show

Arguments:
  • <SELECTION>

    Default value: full

    Possible values:

    • full: Output all data wire has on the entire hive
    • names: Only output a list of node names
Options:
  • -j, --json — Return in JSON format

    Default value: false


This document was generated automatically by clap-markdown.