Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/necojackarc/dotfiles

My dotfiles
https://github.com/necojackarc/dotfiles

bash dotfiles editorconfig gem git pry rspec tmux vim

Last synced: 2 days ago
JSON representation

My dotfiles

Awesome Lists containing this project

README 

        
# dotfiles



My dotfiles



## Supported OSs



* Linux

* macOS



## Dependencies



### Linux



* gcc (vimproc)

* make (vimproc)

* xsel (tmux-yank)



### macOS



* reattach-to-user-namespace (tmux-yank)



## Installation

Clone this repository:



```sh

$ git clone --recursive [email protected]:necojackarc/dotfiles.git ~/dotfiles

```



In case you don't want to overwrite some of your dotfiles in `$HOME`, edit `setup.sh`.



Execute the following commands to create symlinks to the dotfiles:



```sh

$ chmod +x ~/dotfiles/setup.sh

$ ~/dotfiles/setup.sh

```



To make the most of it, install the following packages:



### Git commit signing with GPG



As Git with my configuration always attempts to sign a commit, you have to have a GPG key in your machine.

Generate a new key if you don't have any but make sure your name and email are the same as your Git ones.



- [Managing commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification)



Set the generated GPG key ID by adding the following to `$HOME/.env`, which is not part of this repository but always loaded from 'profile':



```bash

export GIT_CONFIG_PARAMETERS="'user.signingkey='"

```



If you see an error, you can debug with `GIT_TRACE=1`. If you find something wrong in your GPG key, you can edit it with `gpg --edit-key `.



#### Mac



On Max, you need to have `gpg-suite` installed. Plus, you also need to use `gpg2`:



```bash

export GIT_CONFIG_PARAMETERS="'user.signingkey=' 'gpg.program=gpg2'"

```



To enable this configuration, run `killall gpg-agent`.



### CLI tools



* [direnv](https://github.com/direnv/direnv)

* [fzf](https://github.com/junegunn/fzf)

* [gh](https://github.com/cli/cli)

* [ghq](https://github.com/motemen/ghq)

* [git-delta](https://github.com/dandavison/delta)

* [mise](https://github.com/jdx/mise)

* [ripgrep](https://github.com/BurntSushi/ripgrep)

* [tig](https://github.com/jonas/tig)

* [tmux](https://github.com/tmux/tmux)

* [vim-plug](https://github.com/junegunn/vim-plug)



### tmux

After the initial run, do `Ctrl+B -> Shift+I` to install all plugins.



### Vim

Run `PlugInstall` to install all plugins.



### mise

You can install commonly used tools easily such as:



- `mise install node`

- `mise install postgres`

- `mise install awscli`

- `mise install granted`

  - See [AWS Switch Roles](https://github.com/necojackarc/til/blob/master/aws/switch-roles.md)



You can check the installed versions with `mise ls`.



## Tips



### Set computer-specific environment variables



When you'd like to set environment variables that you don't like to commit to the repo but want to set as regular environment variables applied to the logged-in user, you can use a `~/.env` file.

`~/.env` is loaded in .profile, so place `.env` in your home directory.



### Set directory-specific environment variables



`direnv` allows you to set directory-specific variables by placing `.envrc` in the target directory. That file is loaded and unloaded when you get into and get out of that directory.



### Show `***DANGER***` in the prompt message



Set `export IS_DANGER=true` in an `.envrc` where you'd like to display `***DANGER***`.



### Docker Compose

In some environments, they still refer to the old command `docker-compose`. To copse with that, I'd recommend adding the following executable instead of adding an alias:



```bash

#!/bin/bash

docker compose "$@"

```



Then run `chmod +x /usr/local/bin/docker-compose`.