Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adamelliotfields/dotfiles
Shell scripts 🐚
https://github.com/adamelliotfields/dotfiles
bash dotfiles fish shell
Last synced: 3 months ago
JSON representation
Shell scripts 🐚
- Host: GitHub
- URL: https://github.com/adamelliotfields/dotfiles
- Owner: adamelliotfields
- License: mit
- Created: 2023-04-14T13:39:59.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T18:54:00.000Z (5 months ago)
- Last Synced: 2024-09-10T21:12:40.603Z (5 months ago)
- Topics: bash, dotfiles, fish, shell
- Language: Shell
- Homepage:
- Size: 1.87 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
- Codeowners: codeowners
Awesome Lists containing this project
README
dotfiles
You can think of this repo as like a mini-Ansible playbook for setting up a new machine except it is pure Bash. Works on Debian and Mac.
## Installation
Linux programs I use are listed in [`install.sh`](./install.sh) while the Mac ones are in [`mac/.Brewfile`](./mac/.Brewfile).
```sh
git clone https://gh.aef.me/dotfiles.git
./dotfiles/install.sh
```
## Features
* [`apt.sh`](./lib/apt.sh): Updates and installs Apt packages.
* [`btop.sh`](./lib/btop.sh): Installs btop from source for GPU monitoring.
* [`bun.sh`](./lib/bun.sh): Installs Bun with completions for your OS and arch.
* [`chsh.sh`](./lib/chsh.sh): Sets the default shell for the current user.
* [`clean.sh`](./lib/clean.sh): Undoes `link.sh`.
* [`clone.sh`](./lib/clone.sh): Clones GitHub repos to `$HOME`.
* [`deb.sh`](./lib/deb.sh): Installs Deb packages from GitHub Releases.
* [`deno.sh`](./lib/deno.sh): Installs Deno with completions for your OS and arch.
* [`fish.sh`](./lib/fish.sh): Installs Fish from the fish-shell PPA.
* [`go.sh`](./lib/go.sh): Installs Go for your OS and arch.
* [`homebrew.sh`](./lib/homebrew.sh): Installs Homebrew for macOS.
* [`link.sh`](./lib/link.sh): Recursively symlinks files.
* [`miniforge.sh`](./lib/miniforge.sh): Installs Miniforge for your OS and arch.
* [`nerdfont.sh`](./lib/nerdfont.sh): Installs a Nerdfont.
* [`node.sh`](./lib/node.sh): Installs Node LTS via NVM.
* [`python.sh`](./lib/python.sh): Installs Python and Pipx via PyEnv.
* [`rust.sh`](./lib/rust.sh): Installs Rust via Rustup for your OS and arch.
* [`sudoers.sh`](./lib/sudoers.sh): Adds a user to the sudoers file.
## Usage
### Secrets
All shell `*rc` files source `~/.secrets` if it exists. This file should be a series of `export VAR=val` statements. Git ignored.
### Git
Most settings are in [`.config/git/config`](https://github.com/adamelliotfields/dotfiles/blob/main/shared/.config/git/config). The rest go in `~/.gitconfig`:
```properties
[user]
name = # required
email = # required
signingkey =
[diff]
tool =
[merge]
tool =
[commit]
gpgsign = true
```
See the [`git config`](https://git-scm.com/docs/git-config#FILES) docs for details on how the files are resolved.
### GPG
_GNU Privacy Guard_ is the de facto implementation of the OpenPGP (Pretty Good Privacy) standard. I use it so my Git commits are signed.
#### Generate a key
```sh
# install gnupg if necessary
# it's the same package in Homebrew
sudo apt install -y gnupg
# you'll be asked a few questions:
# 1. RSA and RSA
# 2. 4096
# 3. 0 (does not expire)
# then enter your full name and email address; passphrase can be left empty
gpg --full-generate-key
# this command prints the ID of the key associated with your email address
# (you can also use the fingerprint, which is a hash of the public key)
gpg --list-keys --with-colons $YOUR_EMAIL | tr ' ' '\n' | grep '^pub' | cut -d':' -f5
# export the keys and write them by hand on a piece of paper
# the armor flag outputs ASCII (text) instead of binary ("ASCII armor")
# add your email in a comment so you know what the key is for
gpg --armor --comment $YOUR_EMAIL --export $YOUR_EMAIL > your.pub.key
gpg --armor --comment $YOUR_EMAIL --export-secret-keys $YOUR_EMAIL > your.sec.key
```
#### Import a key
If you just made the key, then it is already in the keychain of the computer you made it on. Here's how to import the secret key everywhere else:
```sh
cat your.sec.key | gpg --import
```
Now you have to _trust_ the key so you can sign with it:
```sh
# get the 16-digit key ID again
YOUR_KEY=$(gpg --list-keys --with-colons $YOUR_EMAIL | tr ' ' '\n' | grep '^pub' | cut -d':' -f5)
# enter the following:
# 1. trust (type out the word "trust")
# 2. 5
# 3. y
# 4. quit
gpg --edit-key $YOUR_KEY
```
#### Sign commits
Put this in `~/.gitconfig`:
```properties
[commit]
gpgsign = true
```
Finally, you need to let GitHub know about your key. You can do it through the website or `gh` **if** you have GPG scope on your `GH_TOKEN`.
```sh
gh gpg-key add /path/to/your.pub.key
```
## Inspiration
* [jessfraz/dotfiles](https://github.com/jessfraz/dotfiles)
* [holman/dotfiles](https://github.com/holman/dotfiles)