Dotfiles

Settings for everything: by me, for me.

Table of Contents

• About
• Usage
• Getting Started
• Roadmap
• Contributing
• Acknowledgements

About

I have specific settings and tweaks for my tools that I like. They also (maybe) help me to be productive and consistent. They're here so that:

• I can keep them in sync across lots of different machines.
• I can refer back to a working version if something breaks.
• If I change my mind, I can undo an edit.
• Others can see what works for me, and figure out what works for them.

(back to top)

Usage

Terminal Upgrades

• powerlevel10k theme, with cool colors and icons
• autosuggestions for commands
• syntax highlighting
• auto ls and git status (super convenient!!!)
• ssh shortcuts for my frequent servers
  • ssh pi
  • ssh nas
  • ssh myth
  • ssh sLaptop
• move around the filesystem in one keystroke
  • z <part of folder name>
• paste stuff into the terminal without accidentally running anything
• show and hide hidden files on macOS

Templates

• GitHub README.md (like this one!)
  • template README
• .gitignore that works for lots of situations
  • template gitignore

Scripts

• update all of the everything
  • run_script update
• log anything to the specific channel in my specific workspace
  • log <message>
• alert me via notification on all my devices
  • alert <message>
• play a beep (helpful to chain after long-ish running commands)
  • <do something>; notify
• initialize my personal folder structure
  • run_script init-archive
• make sure all of these dotfiles are up-to-date and properly linked
  • dotbot

Atom Upgrades

• helpful snippets and syntax highlighting (especially for comments)
• settings for plugins

Other Scripts I Use

• autorandr automatically selects a display configuration based on connected devices
• tzupdate is a fully automated utility to set the system time using geolocation
• rofi-calc does live calculations in rofi

(back to top)

Getting Started

These instructions will get you a copy of the project up and running.

Installation

1. Clone the repo:

   git clone https://github.com/TheFirstQuestion/dotfiles.git && cd dotfiles

2. Run the install script:

   ./install

3. In the future, you can update and reinstall by running:

   dotbot

(back to top)

Roadmap

• checkin command that runs on startup
• backup script to sync files with my external hard drive
• cron jobs to schedule certain scripts (i.e. update)
• look into xxh
• different configurations for desktop vs. server
• install all dependencies
  • Atom plugins
  • Keybase
• Better integration with Winston?

(back to top)

Contributing

Collaboration is what makes the world such an amazing place to learn, inspire, and create. Any contributions or suggestions you make are greatly appreciated!

Feel free to do any of the following:

• send me an email
• open an issue with the tag "enhancement"
• fork the repo and create a pull request

(back to top)

Acknowledgements

• The rationale for managing dotfiles this way is explained wonderfully here: https://www.anishathalye.com/2014/08/03/managing-your-dotfiles/
• This repo is essentially a wrapper around Dotbot: https://github.com/anishathalye/dotbot

(back to top)