Installation

The installation is an interactive process. Whether using the standalone installer or the manual method, you will need to provide your own preferences.

Note

GNU Stow is used to manage symlinks and it might fail to do so if it finds an existing file such as a default ~/.bashrc and ~/.profile where it’s trying to create a symlink. Ensure any conflicting files are renamed or backed up to a non-standard location before retrying.

Prerequisites

Watch out!

The installation relies on the GitHub API and because unauthenticated requests are rate limited at 60 requests/hour, the setup will likely fail without a token. To ensure a smooth installation, please generate a Github PAT, with no scopes required and export it as GITHUB_TOKEN before running any of the methods outlined below:

export GITHUB_TOKEN=$(<"$HOME/.GITHUB_TOKEN")

Installation

Standalone Installer

sh <(curl --proto '=https' --tlsv1.3 -sSfL https://envyj020.github.io/dotfiles/run)

Tip

The standalone installer may be inspected before use or alternatively check out the source code directly on GitHub.

curl --proto '=https' --tlsv1.3 -sSfL https://envyj020.github.io/dotfiles/run | less

Manual Installation

1. Clone the repository:

   git clone --depth 1 --recursive git@github.com:envyj020/dotfiles.git
   cd dotfiles

2. Install the OS baseline packages:

   make base

3. Install mise and neovim dependencies:

   make bootstrap

Post-Installation

Congratulations! You’ve successfully installed this desktop environment. To ensure your workspace looks and behaves correctly after a reboot, please complete the following steps:

1. Optional: Set your wallpaper

By default, i3 and/or Sway look for their wallpaper at ~/Pictures/wallpaper.jpg. While a default one is provided with the standalone installer method, you can set your own by replacing it.

2. Optional: API Tokens

API access for certain services requires storing authentication token files under your home directory. The provided .bashrc exports these variables by reading them if they exists and keeps your sensitive keys out of your shell history and configuration files.

The table below outlines the expected filenames:

Env var	Filename	Purpose
GITHUB_TOKEN	~/.GITHUB_TOKEN	Github CLI
TINYURL_TOKEN	~/.TINYURL_TOKEN	Bash URL shortener alias
GEMINI_API_KEY	~/.GEMINI_TOKEN	Gemini CLI
ANTHROPIC_API_KEY	~/.ANTHROPIC_TOKEN	Claude code CLI
AVANTE_GEMINI_API_KEY	~/.AVANTE_GEMINI_TOKEN	Neovim Avante Gemini provider
AVANTE_ANTHROPIC_API_KEY	~/.AVANTE_ANTHROPIC_TOKEN	Neovim Avante Claude provider

3. Optional: Change i3/Sway terminal

While Alacritty is set as the default term, you can switch to your preferred terminal by modifying the $TERMINAL environment variable. This will automatically update the terminal launched by the window manager mod+Enter shortcut.

~/.bashrc.d/00-EXPORTS

...
export TERMINAL=alacritty
export TERMINAL=kitty
...

4. Configure your display layout

i3

Open your terminal and run the following command once you have your monitors arranged the way you like them:

autorandr --save default

autorandr

autorandr was installed as part of the OS baseline. The command above will save your monitor setup so i3 will know which settings to apply upon startup.

Sway

Yet to spot a Wayland-native alternative that effectively replicates the display management workflow provided by arandr and autorandr on x11. For now outputs must be identified and applied right into Sway’s configuration:

1. Identify your output/s:

   swaymsg -t get_outputs | jq -r '.[] | {name} + .rect | "\(.x),\(.y) \(.width)x\(.height) \(.name)"'

2. Open Sway’s config and adjust your output/s to fit your needs:

   ~/.config/sway/config

     ...
     output "eDP-1" mode 1920x1080@120Hz position 0,0
     ...

3. Reload Sway config with $mod+Shift+c

Further reading

Neovim keybindings

Tmux keybindings

Window manager keybindings

GNU Readline keybindings