diff --git a/README.md b/README.md index dc7d817..d7b2594 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,102 @@ # NixOS System Configurations -The following is my Nix configurations. More Docs TBD +My comprehensive Nix configurations for managing multiple hosts, including local machines and remote servers. + +## Repository Layout + +``` +nixos-setup/ +├── bin/ +│ └── skyg # Main CLI tool for managing NixOS configurations +├── configs/ # Application-specific configurations +├── hosts/ # Host-specific NixOS configurations +│ ├── *.nix # Host configuration files (fwbook, hl-bigbox1, hl-minipc*, etc.) +│ ├── *.hardware-configuration.nix # Hardware-specific configurations +│ └── scripts/ # Host-specific scripts +├── modules/ # Reusable NixOS and Home Manager modules +│ ├── core/ # Core system modules +│ ├── home/ # Home Manager modules +│ ├── nixos/ # NixOS-specific modules +│ └── *.nix # Utility modules (lib, skyg-utils, network-drives, etc.) +├── apps/ # Standalone applications +├── flake.nix # Nix flake definition +├── flake.lock # Locked dependency versions +└── README.md # This file +``` + +## Quick Start + +The `skyg` script is your main interface for managing these configurations. It's located in `bin/skyg` and uses NuShell. + +### Available Commands + +#### System Management + +- **`skyg build`** - Build the current system configuration +- **`skyg switch`** - Switch to a new configuration (with confirmation) +- **`skyg test`** - Test a configuration without switching +- **`skyg rollback`** - Rollback to the previous generation + +#### Profile Management + +- **`skyg profiles`** - List all available local profiles +- **`skyg profiles --only_remote`** - List only remote profiles (prefixed with `hl-`) + +#### Flake Updates + +- **`skyg update`** - Update all flakes to their latest versions +- **`skyg update `** - Update a specific flake (e.g., `skyg update nixpkgs`) + +Displays the diff of `flake.lock` after updating. + +#### Remote Deployments + +- **`skyg remote `** - Deploy to a remote machine + +Supported remote commands: `test`, `dry-activate`, `run`, `switch`, `build` + +Example: `skyg remote switch bigbox1` deploys using the `hl-bigbox1` profile to `root@bigbox1.lab.internal` + +#### Home Manager + +- **`skyg hm switch [profile]`** - Apply home-manager configuration (default: `ari`) +- **`skyg hm build [profile]`** - Build home-manager configuration + +Example: `skyg hm switch ari` or `skyg hm switch` + +#### ISO Images + +- **`skyg build-iso`** - Build a bootable ISO image + +## Usage Examples + +```bash +# Check available profiles +skyg profiles + +# Build and switch to new configuration +skyg build +skyg switch + +# Test configuration before switching +skyg test + +# Update dependencies +skyg update nixpkgs + +# Deploy to a remote server +skyg remote switch bigbox1 + +# Rollback if something goes wrong +skyg rollback + +# Apply home-manager changes +skyg hm switch +``` + +## Host Profiles + +Available profiles include: +- **Local**: `fwbook` (Framework laptop) +- **Remote**: `hl-bigbox1`, `hl-bigbox2`, `hl-fwdesk`, `hl-fws1`, `hl-minipc1`, `hl-minipc2`, `hl-minipc3`, `hl-terra1` +- **ISO**: `iso` (bootable image) diff --git a/configs/niri/config.kdl b/configs/niri/config.kdl index daae639..408ced5 100644 --- a/configs/niri/config.kdl +++ b/configs/niri/config.kdl @@ -15,10 +15,10 @@ include "shared/index.kdl" // Uncomment ONE of the following to use that environment: // For DankMaterialShell (DMS) -//include "dms/index.kdl" +include "dms/index.kdl" // For Noctalia -include "noctalia/index.kdl" +//include "noctalia/index.kdl" //include "dms/binds.kdl"