regolith-nix

KO | EN

gitlite — search

#python #react #typescript #golang #android #machine-learning #rust #docker #windows #awesome #cli #vue #awesome-list #security

(★ 12)

This repository aims to port Regolith-Desktop to Nixos [WIP yet Usable]

regolith-nix Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Installing Regolith
Installing Nix
```
sh <(curl -L https://nixos.org/nix/install) --no-daemon
 . ~/.nix-profile/etc/profile.d/nix.sh
export NIX_CONFIG="experimental-features = nix-command flakes"
```

## Cachix Cache
With `cachix` and `nix` installed use `cachix use sandptel` to add my cachix server to be used for pulling regolith-nix binaries.

Nix commands will use the cache:
```
$ nix-build
copying path '/nix/store/n1gwpmvmcgsbnr0a8ncflhvc59db775h-myproject-1.0.0' from 'https://sandptel.cachix.org
...
```
Using this would save you compute power for unchanged derivations.
> https://www.cachix.org/ | 
> https://docs.cachix.org/

## Install Regolith using flake
Add regolith.url to the inputs and import its NixosModule
```
{
  description = "A sample flake for regolith-nix";

inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    homeManager={
      url = "github:nix-community/home-manager";
      inputs.nixpkgs.follows = "nixpkgs";
      };
     regolith.url = "github:regolith-lab/regolith-nix";   
  };

outputs = { self,nixpkgs,home-manager, ... }@inputs: 
  let 
  system = "x86_64-linux";
  pkgs = nixpkgs.legacyPackages.${system};
  in
  {
    nixosConfigurations."<systemname>" = nixpkgs.lib.nixosSystem {
      specialArgs = {inherit system inputs;};
      modules = [
        inputs.regolith.nixosModules.regolith
      ];
    };
    
  };
}

```
## Enable Regolith in configuration
In your config file add the following lines to enable regolith and extraConfig to add your own custom config lines to sway

```
regolith.enable=true;
regolith.sway.extraConfig= ''
# Bind Alt+Enter to open Alacritty
bindsym Mod1+Return exec alacritty'';
```

This will enable add all the required packages along with a displaymanager session.

Use `regolith-session-wayland` command to envoke the session.

## To create a development shell with the following packages..

```nix develop github:sandptel/regolith-nix```

## Features Todo
- [x] Bootable Session on Nixos
- [x] Open for Testing
- [ ] System Daemons Integrations
- [ ] Stable Release
- [ ] flake files to regolith-official repository
- [ ] Regolith-Applications Pushed to Nixpkgs
- [ ] regolith-enable moved to upstream nixpkgs
- [ ] nix-colors integration
- [ ] Install Starter's Scripts Similar to JakooLit Nixos-Hyprland 
- [ ] virtual machine for testing (Hydenix by richen604)
- [ ] Contribution Docs :)

# Design 
### More Information at my [GSoC'24 Report](https://github.com/sandptel/gsoc24 ) 
![regolith(1)](https://github.com/user-attachments/assets/4f152932-f4e2-41e8-8d8c-cd2e2d0e1a9a)

regolith-nix

regolith-nix Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

regolith-nix

regolith-nix Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README