Skip to content

CLI Reference#

This page provides documentation for the nixidy command line tool.

nixidy#

Usage:

nixidy [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

  • apply: Build and apply declarative manifests to Kubernetes.
  • bootstrap: Output a manifest to bootstrap appOfApps.
  • build: Build a nixidy environment.
  • diff: Diff environment manifests.
  • info: Get info about a nixidy environment.
  • switch: Build and switch to a nixidy environment.

nixidy apply#

Build and apply declarative manifests to Kubernetes.

ENVIRONMENT is used to determine if flakes or flake-less nix should be used and which environment should be built.

Example: .#prod Uses a flake in the local directory whereas prod does not use flake but builds the prod environment

Usage:

nixidy apply [OPTIONS] ENVIRONMENT

Options:

  -f, --file PATH  Path to entrypoint nix file (only flake-less).  [default:
                   default.nix]
  --help           Show this message and exit.

nixidy bootstrap#

Output a manifest to bootstrap appOfApps.

ENVIRONMENT is used to determine if flakes or flake-less nix should be used and which environment should be built.

Example: .#prod Uses a flake in the local directory whereas prod does not use flake but builds the prod environment

Usage:

nixidy bootstrap [OPTIONS] ENVIRONMENT

Options:

  -f, --file PATH  Path to entrypoint nix file (only flake-less).  [default:
                   default.nix]
  --help           Show this message and exit.

nixidy build#

Build a nixidy environment.

ENVIRONMENT is used to determine if flakes or flake-less nix should be used and which environment should be built.

Example: .#prod Uses a flake in the local directory whereas prod does not use flake but builds the prod environment

Usage:

nixidy build [OPTIONS] ENVIRONMENT

Options:

  -f, --file PATH    Path to entrypoint nix file (only flake-less).  [default:
                     default.nix]
  --no-link          Don't create a result symlink.
  --out-link PATH    Create a custom result symlink.
  --print-out-paths  Print the resulting output paths.
  --help             Show this message and exit.

nixidy diff#

Diff environment manifests.

ENVIRONMENT is the environment to build and compare with either --path or --env.

Use --path to compare with a previously built environment at a specific path.

Use --env to build and compare with another environment.

Examples:

# Compare prod with staging environment.

nixidy diff .#prod --env .#staging

# Compare prod with previously built manifests in ./manifests/prod

nixidy diff .#prod --path ./manifests/prod

Usage:

nixidy diff [OPTIONS] ENVIRONMENT

Options:

  -f, --file PATH  Path to entrypoint nix file (only flake-less).  [default:
                   default.nix]
  -p, --path PATH  Path to previously built environment to compare to.
  -e, --env ENV    Another environment to build and compare to.
  --help           Show this message and exit.

nixidy info#

Get info about a nixidy environment.

ENVIRONMENT is used to determine if flakes or flake-less nix should be used and which environment should be built.

Example: .#prod Uses a flake in the local directory whereas prod does not use flake but builds the prod environment

Usage:

nixidy info [OPTIONS] ENVIRONMENT

Options:

  -f, --file PATH  Path to entrypoint nix file (only flake-less).  [default:
                   default.nix]
  --json           Output info in JSON format.
  --help           Show this message and exit.

nixidy switch#

Build and switch to a nixidy environment.

ENVIRONMENT is used to determine if flakes or flake-less nix should be used and which environment should be built.

Example: .#prod Uses a flake in the local directory whereas prod does not use flake but builds the prod environment

Usage:

nixidy switch [OPTIONS] ENVIRONMENT

Options:

  -f, --file PATH  Path to entrypoint nix file (only flake-less).  [default:
                   default.nix]
  --help           Show this message and exit.