Awesome Open Source
Awesome Open Source
Sponsorship

CΔƒtΔƒlin’s dotfiles Build Status

These are the base dotfiles that I start with when I set up a new environment. For more specific local needs I use the *.local files described in the Local Settings section.

Table of Contents

Setup

To set up the dotfiles run the appropriate snippet in the terminal:

(⚠️ DO NOT run the setup snippet if you do not fully understand what it does. Seriously, DON'T!)

OS Snippet
macOS bash -c "$(curl -LsS https://raw.github.com/alrra/dotfiles/main/src/os/setup.sh)"
Ubuntu bash -c "$(wget -qO - https://raw.github.com/alrra/dotfiles/main/src/os/setup.sh)"

That's it! ✨

The setup process will:

Setup process in action:

Setup process on macOS Setup process on Ubuntu
macOS Ubuntu

Customize

Local Settings

The dotfiles can be easily extended to suit additional local requirements by using the following files:

~/.bash.local

The ~/.bash.local file will be automatically sourced after all the other Bash related files, thus, allowing its content to add to or overwrite the existing aliases, settings, PATH, etc.

Here is an example:

#!/bin/bash

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

# Set local aliases.

alias g="git"

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

# Set PATH additions.

PATH="$PATH:$HOME/projects/dotfiles/src/bin"

export PATH

~/.gitconfig.local

The ~/.gitconfig.local file will be automatically included after the configurations from ~/.gitconfig, thus, allowing its content to overwrite or add to the existing Git configurations.

Note: Use ~/.gitconfig.local to store sensitive information such as the Git user credentials, e.g.:

[commit]

    # Sign commits using GPG.
    # https://help.github.com/articles/signing-commits-using-gpg/

    gpgSign = true

[user]

    name = Cătălin Mariș
    email = [email protected]
    signingKey = XXXXXXXX

~/.vimrc.local

The ~/.vimrc.local file will be automatically sourced after ~/.vimrc, thus, allowing its content to add or overwrite the settings from ~/.vimrc.

Here is an example:

" Disable arrow keys in insert mode.

inoremap <Down>  <ESC>:echoe "Use j"<CR>
inoremap <Left>  <ESC>:echoe "Use h"<CR>
inoremap <Right> <ESC>:echoe "Use l"<CR>
inoremap <Up>    <ESC>:echoe "Use k"<CR>

" Disable arrow keys in normal mode.

nnoremap <Down>  :echoe "Use j"<CR>
nnoremap <Left>  :echoe "Use h"<CR>
nnoremap <Right> :echoe "Use l"<CR>
nnoremap <Up>    :echoe "Use k"<CR>

Forks

If you decide to fork this project, do not forget to substitute my username with your own in the setup snippets and in the setup script.

Update

To update the dotfiles you can either run the setup script or, if you want to update one particular part, run the appropriate os script.

Screenshots

Git

Output for git status:

Output for Git status on macOS Output for Git status on Ubuntu
macOS Ubuntu

Output for git log:

Output for Git log on macOS Output for Git log on Ubuntu
macOS Ubuntu

tmux & Vim

tmux and Vim on macOS tmux and Vim on Ubuntu
macOS Ubuntu

License

The code is available under the MIT license.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
shell (9,343)Β 
macos (1,524)Β 
vim (801)Β 
git (738)Β 
bash (567)Β 
ubuntu (313)Β 
dotfiles (267)Β 
snippets (146)Β 
tmux (122)Β 

Find Open Source By Browsing 7,000 Topics Across 59 Categories