Skip to content

spejamchr/cfg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cfg

macOS only

Install/Usage

curl -Lks https://raw.githubusercontent.com/spejamchr/cfg/master/install.sh | /bin/bash

If you'd prefer existing dotfiles get overwritten:

OVERWRITE=true curl -Lks https://raw.githubusercontent.com/spejamchr/cfg/master/install.sh | /bin/bash

This script will:

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

Prerequisites

  1. macOS
  2. ruby, git, and zsh (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
  • blueutil: CLI for bluetooth on OSX
  • chruby: Ruby environment tool
  • chunkwm: Tiling window manager for macOS based on plugin architecture
  • cmake: Cross-platform make
  • gnupg: GNU Pretty Good Privacy (PGP) package
  • htop: Improved top (interactive process viewer)
  • imagemagick: Tools and libraries to manipulate images in many formats
  • libyaml: YAML Parser
  • mysql@5.7: Open source relational database management system
  • neovim: Ambitious Vim-fork focused on extensibility and agility
  • pianobar: Command-line player for pandora
  • pkg-config: Manage compile and link flags for libraries
  • puma-dev: A tool to manage rack apps in development with puma
  • rbenv/tap/openssl@1.0: For installing rubies older than 2.4. See also.
  • redis: Persistent key-value database, with built-in net interface
  • 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
  • yarn: JavaScript package manager
  • zplug: The next-generation plugin manager for zsh
  • zsh: UNIX shell (command interpreter)
  • zsh-completions: Additional completion definitions for zsh

Installed with brew cask install:

  • calibre: A powerful and easy to use e-book manager
  • dropbox: Cloud storage
  • firacode: Monospaced font with programming ligatures
  • flux: Warm up your computer display at night
  • gpg-suite-no-mail: Save GPG passwords with GPG Keychain
  • mpv: Media player based on MPlayer and mplayer2
  • sequel-pro: MySQL/MariaDB database management for macOS
  • übersicht: Keep an eye on what is happening on your machine and in the World

Other:

  • kitty: the fast, featureful, GPU based terminal emulator

Debugging

The script will output information to STDOUT, and if the script successfully clones this repo it will 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.