Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakehamilton/tmux
My customized version of tmux, built with Nix.
https://github.com/jakehamilton/tmux
Last synced: about 5 hours ago
JSON representation
My customized version of tmux, built with Nix.
- Host: GitHub
- URL: https://github.com/jakehamilton/tmux
- Owner: jakehamilton
- License: other
- Created: 2022-10-11T04:56:27.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-26T20:03:56.000Z (11 months ago)
- Last Synced: 2024-05-02T03:10:43.622Z (6 months ago)
- Language: Shell
- Size: 26.4 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ✨ tmux Plus Ultra ✨
> Customized tmux, ready for development out of the box.
## Screenshots
## Try Without Installing
You can try this configuration out without committing to installing it on your system by running
the following command.
```nix
nix run github:jakehamilton/tmux
```
## Install
### Nix Profile
You can install this package imperatively with the following command.
```nix
nix profile install github:jakehamilton/tmux
```
### Nix Configuration
You can install this package by adding it as an input to your Nix flake.
```nix
{
description = "My system flake";
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-22.05";
# Snowfall is not required, but will make configuration easier for you.
snowfall-lib = {
url = "github:snowfallorg/lib";
inputs.nixpkgs.follows = "nixpkgs";
};
tmux = {
url = "github:jakehamilton/tmux";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = inputs:
inputs.snowfall-lib.mkFlake {
inherit inputs;
src = ./.;
overlays = with inputs; [
# Use the overlay provided by this flake.
tmux.overlay
# There is also a named overlay, though the output is the same.
tmux.overlays."nixpkgs/plusultra"
];
};
}
```
If you've added the overlay from this flake, then in your system configuration
you can add the `plusultra.tmux` package.
```nix
{ pkgs }:
{
environment.systemPackages = with pkgs; [
plusultra.tmux
];
}
```
## Lib
This flake exports a utility library for creating your own customized version of tmux.
### `lib.mkConfig`
Create a tmux configuration file.
Type: `Attrs -> Path`
Usage:
```nix
mkConfig {
# You must pass through nixpkgs.
inherit pkgs;
# All other attributes are optional.
shell = "${pkgs.bash}/bin/bash";
plugins = with pkgs.tmuxPlugins; [
nord
];
extra-config = ''
set -g history-limit 1000
'';
}
```
## Customization
The tmux package in this flake can be overriden to use a custom configuration. See the
following example for how to create your own derivation.
```nix
{
description = "My tmux flake";
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-22.05";
# Snowfall is not required, but will make configuration easier for you.
snowfall-lib = {
url = "github:snowfallorg/lib";
inputs.nixpkgs.follows = "nixpkgs";
};
tmux = {
url = "github:jakehamilton/tmux";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = inputs:
let
lib = inputs.snowfall-lib.mkLib {
inherit inputs;
src = ./.;
};
in
lib.mkFlake {
outputs-builder = channels:
let
pkgs = channels.nixpkgs;
inherit (inputs.tmux.packages.${pkgs.system}) tmux;
in
{
packages.custom-tmux = tmux.override {
tmux-config = lib.tmux.mkConfig {
inherit pkgs;
plugins = with pkgs.tmuxPlugins; [
nord
tilish
tmux-fzf
];
extra-config = ''
set -g history-limit 2000
'';
};
};
};
};
}
```