cfg

macOS only

Installation

git clone [email protected]:spejamchr/cfg.git ~/cfg

Usage

~/cfg/install.sh

If you'd prefer existing dotfiles get overwritten:

OVERWRITE=true ~/cfg/install.sh

This script will:

1. Ensure several directories exist
2. Install a bunch of stuff (see below for the list)
3. Backup existing dotfiles (Unless you specify OVERWRITE=true)
4. Symlink the dotfiles stored in this repo into place

Prerequisites

1. macOS
2. ruby and git (installed by default on macOS)

You shouldn't have to install anything to run the install script.

Installed Stuff

• Homebrew: The missing package manager for macOS (or Linux)
• macOS command line tools: Commonly used tools, utilities, and compilers

Installed with brew install:

• bat: A cat(1) clone with wings
• rustup: Rust toolchain installer
• blueutil: CLI for bluetooth on OSX
• bun: Incredibly fast JavaScript runtime, bundler, test runner, and package manager – all in one
• chruby-fish: Thin wrapper around chruby to make it work with the Fish shell
• fd: A simple, fast and user-friendly alternative to 'find'
• fzf: 🌸 A command-line fuzzy finder
• htop: Improved top (interactive process viewer)
• neovim: Ambitious Vim-fork focused on extensibility and agility
• pianobar: Command-line player for pandora
• ripgrep: Search tool like grep and The Silver Searcher
• ruby-install: Install Ruby, JRuby, Rubinius, TruffleRuby, or mruby
• skhd: Simple hotkey daemon for macOS
• sleepwatcher: Monitors sleep, wakeup, and idleness of a Mac
• yabai: A tiling window manager for macOS based on binary space partitioning
• yarn: JavaScript package manager

Installed with brew cask install:

• calibre: A powerful and easy to use e-book manager
• docker: App to build and share containerised applications and microservices
• dropbox: Client for the Dropbox cloud storage service
• firefox: Web browser
• font-fira-code-nerd-font: Monospaced font with programming ligatures
• google-chrome: Web browser
• joplin: Note taking and to-do application with synchronisation capabilities
• keepassxc: Cross-platform Password Manager
• kitty@nightly: Cross-platform, fast, feature-rich, GPU based terminal
• slack: Team communication and collaboration software
• übersicht: Keep an eye on what is happening on your machine and in the World
• zoom: Video communication and virtual meeting platform

Other:

• base16_shell: Base16 for Shells

Debugging

The script will output information to STDOUT and store a logfile in the repo at .install.log.

Organization

The install.sh script and the logfile, .install.log, are both at the root of the repo (though the logfile is not tracked by git). The home/ directory holds all the dotfiles. It is organized such that a file home/something will be symlinked to ~/.something, and home/dir/descendant will be symlinked to ~/.dir/descendant.