Skip to content

Latest commit

 

History

History
566 lines (423 loc) · 37.4 KB

README.md

File metadata and controls

566 lines (423 loc) · 37.4 KB
Raw

Kergoth's Dotfiles and Setup Scripts

BlueOak 1.0.0 License

This repository includes my personal application configuration and settings (dotfiles), as well as scripts for setting up systems per my personal preferences.

Prerequisites

  • (On macOS) Command-Line Tools or XCode must be installed (See scripts/extras/ for scripts to install these).

Usage

Initial dotfiles setup

This setup will apply the dotfiles, and will also install packages with home-manager, if nix is installed.

If the repository has not yet been cloned:

chezmoi init --apply kergoth/dotfiles

If the repository is already cloned and you've changed directory to it:

./script/setup

User Setup

This setup will apply the dotfiles, but will also apply other changes to the current user configuration.

After cloning the repository, and changing directory to it, run:

./script/setup-user

On windows (in powershell, not WSL), run this instead:

./script/setup-user.ps1

System Setup

On Arch and FreeBSD, early setup scripts exist in ./script/arch and ./script/freebsd, respectively. These are self-contained and may be used without cloning the repository:

  • os-install: Currently I only have a single script for this, which is Arch. This is run as root, prior to rebooting into the newly installed system, and is intended to install and perform initial early system setup such as bootloader installation. This script is intended to be able to run without cloning this repository, so must be self-contained, and by definition is os/distro-specific, so exists in a subdirectory of script/ for each.
  • setup-root: This is run as root, after OS installation, before our user has sudo/doas access, possibly before our user exists, and its purpose is to do just this, add our user and ensure it can use sudo or doas, and nothing more. This script is intended to be able to run without cloning this repository, so must be self-contained, and by definition is os/distro-specific, so exists in a subdirectory of script/ for each.

The setup-system script is run by a non-root user with sudo/doas access, to perform post-install system-level setup and configuration. This script will apply changes to the system as a whole. This may include installing packages through the package manager, installing nix, et cetera. Ideally this should be run prior to setting up the user, and should be run as a user with sudo access.

After cloning the repository, and changing directory to it, run:

./script/setup-system

On windows (in powershell, not WSL), run this instead:

./script/setup-system.ps1

Edit dotfiles

chezmoi edit --watch ~/.config/zsh/.zshrc

Apply dotfiles changes to the home directory

This step is implicitly done by the boostrap script. To run it manually, for example, after editing files inside the repository checkout, run this:

chezmoi apply

Update the dotfiles, including external files

chezmoi update -R

Update the dotfiles, external files, and home directory packages

./script/update

Manual Setup Steps

Manual Setup Steps for macOS

  • Enable secure keyboard entry in Terminal

  • ./scripts/extras/enable-filevault

  • System Settings > Lock Screen

    • Set “Require password after screen saver begins or display is turned off” to after 5 seconds or less.

  • System Settings > Privacy & Security > Security

    • Set “Allow applications downloaded from App Store and identified developers” at most.

  • Run vscode, enable settings sync

  • Run vivaldi, enable sync

  • Run deliveries, click yes to import from iCloud

  • Run musicharbor, click yes to import from iCloud

  • Run appcleaner, preferences, enable smartdelete

  • Run alfred, preferences, advanced, enable sync to ~/Sync/App Settings/Alfred

  • Safari

    • Change the default scale to 85%
    • Add site settings icon
    • Add cloud tabs icon
    • Rearrange icons

  • Syncthing Shares

    • Sync/dotfiles-local
    • Sync/App Settings
    • Library/Fonts
    • Library/Application Support/Zed/extensions

Manual Setup Steps for Windows

  • Set up all my Syncthing shares

    • AppData/Local/Zed/extensions

  • Restore from backup:

    • $USERPROFILE/Apps
    • Vivaldi: AppData/Local/Vivaldi/User Data/Default/
    • archwsl disk image

  • Run QuickLook, right click its icon, click start at login

  • Create link to CapsLockCtrlEscape.exe in Startup (win-r -> shell:startup)

  • Install Fonts from Sync/Fonts

  • Run vscode, enable settings sync

  • Remove Edge, Store, Mail from the task bar pins.

What's Included

Dotfiles

Zsh Plugins

External Scripts included for non-Windows platforms

  • bat-extras: Scripts that integrate bat with various command line tools.
  • cht.sh: Command-line client for cheat.sh, the only cheat sheet you need.

Fonts

  • iA-Fonts: iA Writer Mono, Duo, and Quattro.
  • MesloLGS NF: Meslo Nerd Font patched for Powerlevel10k.

Installed CLI Software

  • curl: Command line tool and library for transferring data with URLs.

  • wget: A free software package for retrieving files using HTTP, HTTPS, FTP and FTPS.

  • git: A free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.

  • git-lfs: An open source Git extension for versioning large files.

  • neovim: Hyperextensible Vim-based text editor.

  • gnupg: A complete and free implementation of the OpenPGP standard.

  • rust: A multi-paradigm, general-purpose programming language.

  • go: An open source programming language supported by Google

  • python: A programming language that lets you work quickly and integrate systems more effectively.

  • pipx: Install and run python applications in isolated environments.

  • bat: A cat(1) clone with syntax highlighting and Git integration.

  • choose: A human-friendly and fast alternative to cut and (sometimes) awk.

  • delta: A syntax-highlighting pager for git, diff, and grep output.

  • direnv: An extension for your shell which can load and unload environment variables depending on the current directory.

  • duf: Disk Usage/Free Utility - a better 'df' alternative.

  • dua: View disk space usage and delete unwanted data, fast. This is a faster version of ncdu.

  • dust: A more intuitive version of du in rust.

  • eza or exa: A modern replacement for ls.

  • fd: A simple, fast and user-friendly alternative to 'find'.

  • fzf: A command-line fuzzy finder.

  • ghq: Remote repository management made easy.

  • git-absorb: git commit --fixup, but automatic.

  • git-imerge: Incremental merge for git.

  • git-revise: A handy tool for doing efficient in-memory commit rebases & fixups.

  • jira-cli: Feature-rich interactive Jira command line.

  • jq: A lightweight and flexible command-line JSON processor.

  • ripgrep: A line-oriented search tool that recursively searches the current directory for a regex pattern.

  • rusage.com: Provides the best possible way to report resource usage statistics when launching command line programs.

  • sad: CLI search and replace | Space Age seD.

  • sd: Intuitive find & replace CLI (sed alternative).

  • shellcheck: A static analysis tool for shell scripts.

  • shfmt: Format shell programs.

  • tealdeer: Simplified, example based and community-driven man pages.

  • unar: Universal archives extractor. Available via brew, nix, and scoop.

  • zoxide: A smarter cd command, inspired by z and autojump.

  • zstd: Zstandard - Fast real-time compression algorithm.

CLI Software on Linux and macOS

  • nix: Nix is a tool that takes a unique approach to package management and system configuration.

CLI Software on Linux, macOS, and FreeBSD

  • patchutils: A small collection of programs that operate on patch files.

    • On Windows, patchutils can be used via either WSL or MSYS2 (which can be installed via scoop and run as msys2, ex. msys2 -c 'exec filterdiff "$@"' -).

  • ssh-copy-id: Install your identity.pub in a remote machine’s authorized_keys.

    • On Windows, I have a powershell function which does this, and is aliased to ssh-copy-id.

  • tmux: An open-source terminal multiplexer.

    • There are no good options for tmux or tmux-equivalent on Windows. The closest you can get is just splits in Windows Terminal, which doesn't give you the ability to disconnect.

CLI Software on Linux, macOS, and Windows

  • sapling: A Scalable, User-Friendly Source Control System.

CLI Software on macOS

  • lima: Linux virtual machines, typically on macOS, for running containerd.
  • colima: Container runtimes on macOS (and Linux) with minimal setup.
  • duti: A command-line tool to select default applications for document types and URL schemes on Mac OS X.
  • mas: Mac App Store command line interface.
  • reattach-to-user-namespace: Reattach to the per-user bootstrap namespace. This is needed for tools like tmux, though tmux 2.6+ apparently incorporates this functionality already.
  • trash: A small command-line program for OS X that moves files or folders to the trash.

CLI Software on Linux and FreeBSD

The intention is to incorporate the installation of Nix on all systems in time.

  • zsh: A shell designed for interactive use, although it is also a powerful scripting language. This is installed by default on macOS.
CLI Software on Arch Linux
  • openssh: The premier connectivity tool for remote login with the SSH protocol.
  • avahi: A system which facilitates service discovery on a local network via mDNS.
  • nss-mdns: A GNU Libc NSS module that provides mDNS host name resolution.
CLI Software on WSL2
  • socat: Multipurpose relay for bidirectional data transfer. This is required for npiperelay.

CLI Software on Windows

  • bat-extras: Scripts that integrate bat with various command line tools.
  • Build Tools for Visual Studio 2022: These Build Tools allow you to build Visual Studio projects from a command-line interface.
  • cht.exe: cht.sh libcurl client for Windows.
  • gow: Unix command line utilities installer for Windows.
  • gsudo: Sudo for Windows.
  • npiperelay: Access Windows named pipes from WSL.
  • scoop: A command-line installer for Windows.
  • starship: A cross-shell prompt.
  • winget: Windows Package Manager CLI.

Powershell Modules

  • DirColors: Provides dircolors-like functionality to all System.IO.FilesystemInfo formatters.
  • posh-alias: A better alias for Powershell.
  • PSFzf: A PowerShell wrapper around the fuzzy finder fzf.
  • Recycle: Deletes the file or folder as if it had been done via File Explorer, or restores a deleted file from the recycle bin.

Powershell Modules on Windows only

Installed GUI Software (MacOS & Windows Only)

GUI Software on Windows and macOS

GUI Software on macOS (Pre-Sonoma Only)

  • Aerial (Open-Source): A macOS screensaver that lets you play videos from Apple's tvOS screensaver.

GUI Software on macOS

  • Alfred: Application uninstaller.
  • AppCleaner: A small application which allows you to thoroughly uninstall unwanted apps.
  • BlockBlock: Monitors common persistence locations and alerts whenever a persistent component is added.
  • Brooklyn (Open-Source): Screen saver based on animations presented during Apple Special Event Brooklyn.
  • Calibre (Open-Source): E-books management software.
  • CleanMyDrive 2
  • DaisyDisk: Disk space visualizer. Get a visual breakdown of your disk space in form of an interactive map, reveal the biggest space wasters, and remove them with a simple drag and drop.
  • DevDocs for macOS (Open-Source): An unofficial DevDocs API Documentation viewer for macOS.
  • GPG Suite (Open-Source): Tools to protect your emails and files.
  • Ice (Open-Source): Powerful menu bar manager for macOS.
  • Karabiner-Elements (Open-Source): A powerful and stable keyboard customizer for macOS.
  • kitty (Open-Source): The fast, feature-rich, GPU based terminal emulator.
  • LilyView
  • LuLu: The free, open-source firewall that aims to block unknown outgoing connections.
  • MusicHarbor
  • PopClip: Instant text actions.
  • Readwise Reader: Save everything to one place, highlight like a pro, and replace several apps with Reader.
  • Rectangle (Open-Source): Move and resize windows in macOS using keyboard shortcuts or snap areas.
  • Shifty: Menu bar app that provides more control over Night Shift.
  • SwiftDefaultApps (Open-Source): A preference pane will let you view and change default application associations.
  • SyncThing (Open-Source): A continuous file synchronization program.
  • The Unarchiver: Unpack archive files.
  • Transmission Remote GUI (Open-Source): A feature rich cross platform Transmission BitTorrent client. Faster and has more functionality than the built-in web GUI.
  • UnPlugged
  • WhatsYourSign: Add a menu item to Finder to display a file's cryptographic information.
  • WiFi Explorer: Best Wi-Fi Analyzer & Monitor.
  • WiFi Signal: WiFi Connection Status Monitor.
Safari Extensions
QuickLook Plugins
  • Apparency: Preview the contents of a macOS app
  • BetterZip: A trialware file archiver. I only install this for the QuickLook plugin.
  • QLColorCode (Open-Source): A Quick Look plug-in that renders source code with syntax highlighting
  • qlImageSize (Open-Source): Display image size and resolution
  • QLMarkDown (Open-Source): Preview Markdown files
  • QLPrettyPatch (Open-Source): QuickLook generator for patch files
  • QLStephen (Open-Source): Preview plain text files without or with unknown file extension. Example: README, CHANGELOG, index.styl, etc
  • QLVideo (Open-Source): Preview most types of video files, as well as their thumbnails, cover art and metadata
  • quicklook-csv (Open-Source): A QuickLook plugin for CSV files
  • QuickLookJSON: A useful quick look plugin to preview JSON files
  • QuickLookASE (Open-Source): Preview Adobe ASE Color Swatches generated with Adobe Photoshop, Adobe Illustrator, Adobe Color CC, Spectrum, COLOURlovers, Prisma, among many others
  • Suspicious Package: Preview the contents of a standard Apple installer package
  • WebPQuickLook (Open-Source): QuickLook plugin for WebP image files

GUI Software on Windows

Apps I install on an as-needed basis

As needed CLI Software

  • asciinema]: Recording terminal sessions and sharing them on the web. Available via brew, nix, and python.
  • aria2: A lightweight multi-protocol & multi-source, cross platform download utility operated in command-line. It supports HTTP/HTTPS, FTP, SFTP, BitTorrent and Metalink. Available via brew, nix, and scoop.
  • broot: A new way to see and navigate directory trees. Available via brew, nix, scoop, and cargo.
  • chars. Tool to display names and codes for unicode codepoints. Available via brew, nix, and cargo.
  • csview: 📠 Pretty and fast csv viewer for cli with cjk/emoji support. Available via brew, nix, scoop, and cargo.
  • csvkit: A suite of utilities for converting to and working with CSV. Available via brew, nix, and python.
  • dasel: Select, put and delete data from JSON, TOML, YAML, XML and CSV files with a single tool. Available via brew, nix, scoop, and go.
  • dirdiff: Efficiently compute the differences between two directories. Available via cargo as dirdiff-ocamlpro.
  • dog: A command-line DNS client. Available via brew as dog, nix as dogdns, and cargo from the source.
  • entr: Run arbitrary commands when files change. Available via brew and nix.
  • eva: A simple calculator REPL, similar to bc. Available via brew, nix, and cargo.
  • fast: Minimal zero-dependency utility for testing your internet download speed from terminal. Available via nix as fast-cli and go.
  • fclones: Finds and removes duplicate files. Available via brew, nix, and cargo.
  • ffmpeg: A complete, cross-platform solution to record, convert and stream audio and video. Available via brew, nix, and scoop.
  • flint: Check your project for common sources of contributor friction. Available via brew as flint-checker and go.
  • git-filter-repo: Quickly rewrite git repository history (filter-branch replacement).
  • hexyl: A simple hex viewer for the terminal. Available via brew, nix, and cargo.
  • htop: An interactive process viewer. Available via brew and nix.
  • httpie: A command-line HTTP client. Available via brew, nix, and python.
  • huniq: Command line utility to remove duplicates from the given input. Available via nix and cargo. Uses less memory than awk/uniq-seen. Rarely needed.
  • hyperfine: A command-line benchmarking tool. Available via brew, nix, and cargo.
  • jc: CLI tool and python library that converts the output of popular command-line tools, file-types, and common strings to JSON, YAML, or Dictionaries. Available via brew, nix, scoop, and pypi.
  • petname: Generate human readable random names. Available via pypi and cargo.
  • procs: A modern replacement for ps written in Rust. Available via brew, nix, scoop, and cargo.
  • pup: A command line tool for processing HTML. Available via brew, nix, and go.
  • rclone: Rsync for cloud storage. Available via brew, nix, and scoop.
  • titlecase: A small tool that capitalizes English text. Available via cargo.
  • vivid: A generator for the LS_COLORS environment variable. Available via brew, nix, and cargo.
  • youtube-dl: Video downloading. Available via brew, nix, and python.

On my NAS, to download what I own

  • lgogdownloader: Unofficial downloader for GOG.com. Available via brew and nix.

To deal with icons and images

  • icoutils: A set of command-line programs for extracting and converting images in Microsoft Windows(R) icon and cursor files. Available via brew and nix.
  • imagemagick: Create, edit, compose, or convert digital images. Available via brew, nix, and scoop.

For beets

  • mp3val: A small, high-speed, free software tool for checking MPEG audio files' integrity. Available via brew and nix. Also available as direct binary download for Windows.
  • par2cmdline: Available via brew as par2, nix, and scoop.

As Needed CLI Software for macOS

  • makeicns: Create icns files from the command line. Available via brew.
  • terminal-notifier: A command-line tool to send macOS User Notifications. Available via brew and nix.

As Needed GUI Software

  • Balena Etcher: Flash OS images to SD cards & USB drives, safely and easily. Available via brew as balenaetcher, winget as Balena.Etcher, and scoop as extras/etcher.
  • Battle.net: Blizzard games client. Available via brew as battle-net.
  • czkawka: Multi functional app to find duplicates, empty folders, similar images etc.
  • dupeGuru: A cross-platform GUI tool to find duplicate files in a system.
  • HandBrake: The open source video transcoder. Available via brew as handbrake and winget as HandBrake.HandBrake.
  • Malwarebytes: Warns about malware, adware and spyware.
  • MusicBrainz Picard: A cross-platform music tagger. Available via brew as musicbrainz-picard, nix as picard, Microsoft Store, winget as MusicBrainz.Picard, and scoop as picard.
  • Steam: A digital distribution platform. Available via brew, nix, and winget as Valve.Steam.
  • Video Duplicate Finder: Cross-platform software to find duplicated video (and image) files on hard disk based on similiarity.

As Needed GUI Software for macOS

  • Adapter: Convert Video, Audio and Images. Available via brew as adapter.
  • Burn: Simple but advanced burning for Mac OS X. Optional, as disk images can be burned with Finder or hdiutil. Available via brew as burn.
  • Gemini 2: The intelligent duplicate file finder. Available via brew as gemini.
  • KnockKnock: See what's persistently installed on your Mac.
  • Numbers: Create impressive spreadsheets. Available via Mac App Store.
  • Onyx: Verify system files structure, run miscellaneous maintenance and more. Available via brew as onyx.
  • Pages: Documents that stand apart. Available via Mac App Store.
  • PhotoSweeper: A fast & powerful duplicate photos cleaner for Mac. Available via brew as photosweeper-x.
  • Pixelmator Classic: Powerful, full-featured image editor for Mac. Available via Mac App Store.
  • SwiftBar]: Powerful macOS menu bar customization tool.
  • TaskExplorer: Explore all the tasks (processes) running on your Mac with TaskExplorer.
  • Wineskin: A user-friendly tool used to make ports of Microsoft Windows software to macOS. Available via brew as gcenx/wine/unofficial-wineskin.
  • XLD: Lossless audio decoder.

As Needed GUI Software for Windows (All are available via winget)

  • Autoruns (from Sysinternals)
  • BleachBit: Clean Your System and Free Disk Space. Available via winget as BleachBit.BleachBit.
  • Exact Audio Copy: Audio grabber for audio CDs using standard CD and DVD-ROM drives
  • ImDisk: Mount image files of hard drive, cd-rom or floppy.
  • ImgBurn: A lightweight CD / DVD / HD DVD / Blu-ray burning application. Available via winget as LIGHTNINGUK.ImgBurn.
  • Paint.NET
  • Process Explorer (from Sysinternals)
  • WinImage: A fully-fledged disk-imaging suite for easy creation, reading and editing of many image formats and fileystems.
  • WinSCP

Formerly-Used

Formerly-Used Applications

  • ACDSee. Loved this as an ultralight image viewer in the past, but it grew bloated over time, so was replaced by Irfan View or XnView, as needed.
  • foobar2000: This is a great music player, but I use Apple Music and iTunes for streaming, and beets for my music library for portable devices, so this is no longer needed.
  • Winamp: This was the way before I switched to foobar2000 long ago.

Formerly-Used Fonts

Formerly-Used Fonts - Occasional Use

Implementation Notes

  • Chezmoi is used to apply my dotfiles changes.
  • A script is run by chezmoi which applies my nix home-manager configuration, if nix is installed.
  • .config/git/config is not my main configuration, but is instead a small file which includes my main configuration. This allows for automatic git configuration changes such as vscode's change to credential.manager to be obeyed without it altering my stored git configuration. The downside to this is that these changes will not be highly visible. I may change this back, or keep the including file but track it so the changes are visible.

Reference

Chezmoi Usage

Supported Platforms

  • Linux. Tested on Arch, Ubuntu, and Debian.
  • MacOS.
  • FreeBSD.
  • Windows.

Help

Questions and comments are always welcome, please open an issue.

Contributing

Contributions of all kinds, including feedback, are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project's Code of Conduct and follow The Ethical Source Principles.

License

Distributed under the terms of the Blue Oak Model License 1.0.0 license.

See Also

Superseded Projects

Mostly Superseded Projects