https://github.com/chriscarini/dotfiles
My personal dotfiles
https://github.com/chriscarini/dotfiles
Last synced: 6 months ago
JSON representation
My personal dotfiles
- Host: GitHub
- URL: https://github.com/chriscarini/dotfiles
- Owner: ChrisCarini
- Created: 2018-07-25T00:37:01.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-15T07:54:08.000Z (9 months ago)
- Last Synced: 2025-03-29T11:05:49.708Z (6 months ago)
- Language: Shell
- Homepage:
- Size: 2.89 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chris' dotfiles
## Installation
🖥
🐶 💻
💲 curl -sL git.io/.bash | sh
## Description
These are my dotfiles. Use at your own risk.
These are primarily used on Mac OS systems, but might be able to be used on Linux as well.
## Features
### Mac OS Specifics
These dotfiles allow the following Mac OS specific dotfiles to be sourced after all other supported dotfiles:
1. `.path.macos`
1. `.env.macos`
1. `.alias.macos`
1. `.functions.macos`
### Work Specific dotfiles
This repository allows the creation and use of work-specific dotfiles. Everything is contained under the `$DOTFILES_DIR/work/` directory (which is ignored by this repository). This allows for the two repositories to be maintained individually.
Similar to the structure of this repository, we allow for the following folders:
1. `$DOTFILES_DIR/work/README.md`
1. `$DOTFILES_DIR/work/git`
1. `$DOTFILES_DIR/work/system`
#### Work `dotfiles` Initialization
To initialize the dotfiles that can be used in these directories, you can simply run:
```bash
source ~/dotfiles/bin/create_work_dotfiles.sh
```
#### Nuances
The below files will be preferred over the ones contained within this repository.
1. `$DOTFILES_DIR/work/git/.gitconfig`
1. `$DOTFILES_DIR/work/git/.gitignore_global`
### Banners
##### How does the banner work?
The banners file(s) need to set the variable `BANNER_OUTPUT`.
Upon sourcing all of the `.banner` files, this variable is printed via:
```bash
printf "$BANNER_OUTPUT"
```
##### Banner dotfiles Sourcing Hierarchy
1. `$DOTFILES_DIR/system/.banner`
1. `$DOTFILES_DIR/system/.banner_*`
1. `$DOTFILES_DIR/work/system/.banner`
1. `$DOTFILES_DIR/work/system/.banner`
##### Why did I chose to have the banner work this way?
Very simply, because I wanted a different banner for my work environment than my personal. The current implementation allows this in a fairly trivial manner.
### The `dotfiles` command
```bash
$ dotfiles help
Usage: dotfiles
Commands:
clean Clean up caches (brew)
dock Apply macOS Dock settings
edit Open dotfiles in IDE (code) and Git GUI (stree)
help This help message
macos Apply macOS system defaults
update Update packages and pkg managers (OS, brew, npm, gem)
```
## Additional resources
* [Awesome Dotfiles](https://github.com/webpro/awesome-dotfiles)
* [Homebrew](https://brew.sh)
* [homebrew-cask](https://caskroom.github.io) / [usage](https://github.com/phinze/homebrew-cask/blob/master/USAGE.md)
* [Bash prompt](https://wiki.archlinux.org/index.php/Color_Bash_Prompt)
## Credits
I borrowed (and tweaked) a fair bit from:
* [Lars Kappert's dotfiles](https://github.com/webpro/dotfiles)
* [Markus Reiter's dotfiles](https://github.com/reitermarkus/dotfiles)
Additionally, the [dotfiles community](https://dotfiles.github.io) happens to have a **TON** of great examples of other peoples `dotfiles`.