Skip to content

Latest commit

 

History

History
112 lines (89 loc) · 3.71 KB

README.md

File metadata and controls

112 lines (89 loc) · 3.71 KB
Raw

nixos

A unified NixOS management tool.

Introduction

This is a unification of all the different pick NixOS tooling into one executable. NixOS has its various tools spread out between several large scripts that have become on the verge of unmaintainable. This tool has one goal: to create a modular NixOS CLI that mirrors or enhances the functionality of all current NixOS tooling in nixpkgs, adds on to it if needed, and eventually come to replace it entirely.

  • nixos-rebuild → nixos apply + nixos generation
  • nixos-enter → nixos enter
  • nixos-generate-config → nixos init
  • nixos-version → nixos info
  • nixos-install → nixos install
  • nixos-info → nixos manual

More to come in the future, see TODO for a list of commands that are planned to be implemented.

Usage

Use this repo as a flake input. A NixOS module is also provided, and this is the recommended way to use this program.

{
  inputs.nixos-cli.url = "github:water-sucks/nixos";

  outputs = { nixpkgs, nixos-cli, ... }: {
    nixosConfigurations.system-name = nixpkgs.lib.nixosSystem {
      modules = [
        nixos-cli.nixosModules.nixos-cli
        # other configuration goes here
      ];
    };
  };
}

Configuration

This can be configured using the NixOS module (the preferred way), which generates a file at /etc/nixos-cli/config.toml.

The default configuration with all available options and examples is as follows:

# Aliases for long commands that you don't want to type out. All arguments
# after the aliases are passed as-is to the underlying command.
[[aliases]]
# alias = "genlist" # Name of the alias; must not contain spaces
# resolve = ["generation", "list"] # Args to resolve this alias, as a list of strings

# Multiple aliases must be defined separately (this is a limitation of the
# TOML parsing library and will be fixed in the future)
# [[aliases]]
# alias = "switch"
# resolve = ["generation", "switch"]

# Configuration for the `apply` subcommand.
[apply]
specialisation = "" # Name of specialisation to use by default
config_location = "/etc/nixos" # Where to look for configuration by default
use_nom = false # Use `nix-output-monitor` as an alternative `nix build` front-end

# Configuration for the `enter` subcommand.
[enter]
mount_resolv_conf = true # Bind-mount the host `resolv.conf` inside the chroot for internet access

# Configuration for the `init` subcommand. This is managed by `nixpkgs`, and
# normally should not be touched unless you know what you are doing.
[init]
enable_xserver = false # Generate options to enable X11 display server
desktop_config = "" # Configuration options for a desktop environment to include by default
extra_config = "" # Extra configuration to append to `configuration.nix` as a string

# Extra configuration to append to `configuration.nix`, as structured key-value pairs
[[init.extra_attrs]]
# name = "" # Name of key
# value = "" # Name of value

Some of the configuration is a little awkward to specify right now, such as aliases, but I plan to fix that in the future once I can find a TOML parsing library that supports dynamic key-value pairs.

TODO

Implemented Commands/Flags

  • ➖ apply
  • ❌ container
  • ✅ enter
  • ✅ info
  • ✅ init
  • ➖ install
  • ➖ generation
    • ✅ list
    • ✅ switch <number>
    • ✅ rollback
    • ➖ diff (a la nvd)
  • ✅ manual
  • ❌ option
  • ✅ repl

Possible Future Commands

I would like for this to become a standard NixOS tool, which means that I want to cater to potentially many interests. If you would like for any subcommands to be implemented that you think fit this project, please file an issue.