004a/dotfiles

My dotfiles, configurations, shell scripts and bin utilities.

dotfiles

My configurations and shell scripts.

Currently, it is only a personal workplace rather than a framework. So you should FORK the REPO first before using it.

TOC

• Environments
• Dependencies
• Features
• Preview
• Installation
• Configuration
  • Modifications by yourself
  • UI
  • Dotfiles
• Usage
  • Bootstrap
  • Install
• File Structure
• Bash initialization process
• Bash-it Enables/Disables
• Customize your Bash
  • Binary executables
    • Sub-commands
  • Secret Data
• Version
• Suggestion, Bug Reporting, Contributing
• Copyright and License

Environments

• iTerm2 Build 3.0.14 (Terminal.app compatible)
• GNU bash 4.4.12(1)-release (x86_64-apple-darwin15.6.0) (GNU bash v3 compatible)
• Tmux 2.3 (Not necessary. Tmux compatible)

Dependencies

• git: It is required. Make sure it available before installation.
  • git-prompt: If omitted, PS1 will not show git prompt.
• dotbot: To create symbolic links and manage the map via install.conf.yaml. There is no need to install dotbot manually. It is a part of this repo.
• bash-it (modified version): To manage all shell scripts in modules: aliases, plugins, completions and shell appearance theme. It is required. Make sure it available before installation.

Features

• Manage collections of dotfiles via dotbot. See the configuration.
• Manage shell scripts/completions/aliases/plugins by modules via bash-it.
  • Most features are implemented in separate plugins, which could be disabled by yourself.
  • All my plugins are put in bash-custom/ folder. And some enabled plugins provided by bash-it. Refer to Bash-it Enables/Disables.
  • Compatible with bash-completion (for bash 3.x) and bash-completion2 (for bash 4.x). See the configuration
• Auto-execute specific scripts for different system (ubuntu/macos and so on).
• Responsive and pretty PS1, and personalized theme 𝕬. Refer to Preview.
• Collections of shell commands, which locates in bin/ directory. Refer to Binary executables.
• Manage sub commands, which locates in bin/sub/ directory. The manage framework is modified from sub.
  • Default SUB_NAME=a，press a help to see help. You can modify the enterpoint (SUB_NAME) in Plugin: sub.plugin.bash
  • Refer to Sub-commands for more.
• My best practices for shell (bash).
• My best practices for todo.cli.
• My best practices for neovim. See the configuration.
• My best practices for tmux. See the configuration.
• My best practices for git. See the configuration.
• My cheat sheets based on chrisallenlane/cheat.
• Maintain your classified data in secrets/ folder, which is ignored by git. Refer to Secret Data.
• Integrated with spencertipping/cd.
• Integrated with fzf. See the configuration.

Preview

Responsive UI (Adjust with window width). No need to restart Terminal. Only press Enter:

Highlight Backgound jobs:

Use sub commands:

Installation

# Clone this repo
DOTFILE_DIR=~/dotfiles
git clone --depth 1 --recursive https://github.com/adoyle-h/dotfiles.git $DOTFILE_DIR
# Install bash_it framework which is required
git clone --depth 1 https://github.com/adoyle-h/bash-it ~/.bash_it
~/.bash_it/install.sh --no-modify-config
${DOTFILE_DIR}/bash_it/reset.sh
# Put your classified data in `secrets/` folder
mkdir -p ${DOTFILE_DIR}/secrets
# cheat is optional
git clone --depth 1 https://github.com/adoyle-h/my-command-cheat.git ${DOTFILE_DIR}/cheat
# neovim-config is optional
git clone --depth 1 --recursive https://github.com/adoyle-h/neovim-config.git ${DOTFILE_DIR}/nvim
# spencertipping/cd is optional
mkdir -p ~/.cd && git clone --depth 1 https://github.com/spencertipping/cd.git ~/.cd/core
# check `install.conf.yaml` file
# make soft-links for dotfiles
./install
# checkout the output

And then read the Configuration - Modifications by yourself section.

Configuration

Modifications by yourself

These parts of below files you should modify:

./configs/gitconfig:

[user]
    name = <your-username>
    email = <your-email>

UI

$TERM should be xterm-256color or screen-256color for best appearance.

• Font: DejaVuSansMonoForPowerline Nerd Font Book
• Color Scheme: Deep. Installation Instructions

Dotfiles

Edit the install.conf.yaml file.

Usage

Bootstrap

IT IS UNDER DEVELOPMENT. DO NOT USE!

Run ./bootstrap to initialize in a new environment.

Do not call the script under sudo.

Install

Run ./install to create symbolic links.

Do not call the script under sudo.

File Structure

.
├── README.md
├── bash/
│   ├── bash_profile                # Link to ~/.bash_profile
│   ├── bashrc                      # Link to ~/.bashrc
│   ├── inputrc                     # Link to ~/.inputrc
│   └── profile                     # Link to ~/.profile
├── bash-custom/                    # your bash scripts
│   ├── Debian/                     # bash scripts for Linux Debian
│   │   └── core.bash
│   ├── aliases.shell.bash          # same to bash_it aliases
│   ├── available/                  # Custom available bash scripts
│   │   └── zzz_last_cd.plugin.bash # Ensure the plugin should be loaded at last
│   ├── bash_4.plugin.bash
│   ├── cheat.plugin.bash
│   ├── completions.shell.bash      # same to bash_it completions
│   ├── editor.env.bash
│   ├── enabled/                    # Custom enabled bash scripts
│   │   └── zzz_last_cd.plugin.bash -> ../available/zzz_last_cd.plugin.bash
│   ├── env.shell.bash
│   ├── functions.shell.bash        # same to bash_it lib
│   ├── fzf.plugin.bash
│   ├── gvm.plugin.bash
│   ├── lesspipe.plugin.bash
│   ├── Macos/                      # bash scripts for Macos
│   │   └── core.bash
│   ├── optionals.shell.bash        # Shell Optional Behavior settings
│   ├── path.env.bash               # change environment variable PATH
│   ├── proxy.env.bash              # application proxy settings
│   ├── secrets.env.bash -> ../secrets/secrets.env.bash
│   ├── system-detect.shell.bash    # detect system and run its bash scripts
│   ├── themes/                     # the bash_it theme
│   │   └── 𝕬/
│   │       └── 𝕬.theme.bash
│   ├── tmux.plugin.bash
│   ├── variables.shell.bash        # Shell Variables settings
│   └── xcode.plugin.bash
├── bash_it/                        # https://github.com/Bash-it/bash-it#your-custom-scripts-aliases-themes-and-functions
│   ├── aliases.bash
│   ├── completions.bash
│   ├── enable.bash                 # bash_it configuration and entrance
│   ├── lib.bash                    # Reset $PATH and $MANPATH, and set common functions
│   ├── plugins.bash
│   └── reset.sh                    # custom reset bash-it aliases/plugins/completions
├── bin/                            # link to ~/bin
│   ├── sub/                        # Collections of sub commands
│   ├── sub-bin*                    # Sub main file
│   └── a -> ./sub-bin              # Enterpoint of sub commands
├── bootstrap -> ./bootstrap.bash*
├── bootstrap.bash*
├── cheat/                          # It is ignored in git. git clone https://github.com/adoyle-h/my-command-cheat cheat
├── completions/                    # bash completions
├── configs/                        # application configuration
├── dotbot/                         # https://github.com/anishathalye/dotbot
├── install*
├── install.conf.yaml               # dotbot configuration
├── nvim/                           # neovim configuration. It is ignored in git. git clone https://github.com/adoyle-h/neovim-config nvim
└── secrets/                        # Put your sensitive data here. It is ignored in git. mkdir secrets
    └── secrets.env.bash

Bash initialization process

It will generally execute these scripts in order:

1. bash/bashrc
2. bash_it/enable
3. bash_it framework
   1. bash_it/{lib,aliases,completions,plugins}
4. bash-custom/*.bash
   1. system-detect.shell.bash
      • Macos/*.bash
      • Debian/*.bash
5. bash-custom/enabled/*.bash

Bash-it Enables/Disables

The aliases/plugins/completions I enabled could be referred in bash_it/reset.sh.

Customize your Bash

All your own plugins should be put in bash-custom/.

Sometimes, you could modify the files in bash_it/ for prior execution.

You should leave the bash/ folder alone. DO NOT CHANGE ANYTHING IN IT.

Binary executables

All your own binary executables should be put in bin folder.

Sub-commands

These executables could also be put in bin/sub/ which is included in $PATH, and it could be referred as sub-command. Example:

• a help
• a comments
• a 256color

All sub-commands are auto-completed. Type a <Tab> to see all sub-commands.

Secret Data

Type ll bash-custom/secrets.env.bash, and you will see that:

bash-custom/secrets.env.bash@ -> ../secrets/secrets.env.bash

So, you could maintain your classified data in secrets/secrets.env.bash.

The secrets/ folder is ignored by git. You could put anything in this folder.

Version

No version yet

Suggestion, Bug Reporting, Contributing

Sorry, the project is a personal project which do not accept any Pull Requests. You could fork the repo to build your own project.

Any comments and suggestions are always welcome. Please open an issue to contact with me.

Copyright and License

Copyright (c) 2017 ADoyle. The project is licensed under the BSD 3-clause License.

See the LICENSE file for the specific language governing permissions and limitations under the License.

See the NOTICE file distributed with this work for additional information regarding copyright ownership.