Giter Club home page Giter Club logo

shell-config's Introduction

shell-config

shell-config is a personal dotfiles repository for shell (bash, zsh and tmux). It is compatible with vcsh-dotfiles.

Part of ek9/dotfiles collection.

Requirements

Install

Clone via vcsh-dotfiles:

$ vcsh-dotfiles clone https://github.com/ek9/shell-config

When starting new shell (bash or zsh), a new tmux session should start automatically. The first time it will start, it will install [TPM and tmux plugins](#tmux plugins).

Overview

Features

  • Enables automatic tmux start for all shell sessions (tres to attach to detached sessions first).
  • Starts keychain SSH Agent automatically.
  • Sets up bash shell with liquidprompt and [oh-my-git][11].
  • Sets up zsh shell with [antigen][30], [oh-my-zsh][31] and liquidprompt enabled.
  • Sets up tmux with [TPM plugins](#tmux plugins) (note tmux plugin install must be initialized manually via Alt+a Shift+I).
  • Sets up basic configuration for bash and zsh and allows extending it further by using Directory Structure.

tmux plugins

A list of plugins that are enabled in .tmux.conf:

Directories

XDG directory structure (changes to defaults via .config/user-dirs.dirs file):

  • XDG_DESKTOP_DIR and XDG_DOWNLOAD_DIR set to $HOME/inbox.
  • XDG_DOCUMENTS_DIR set to $HOME/life
  • XDG_MUSIC_DIR set to $HOME/share/music
  • XDG_PICTURES_DIR set to $HOME/image
  • XDG_PUBLICSHARE_DIR set to $HOME/share
  • XDG_TEMPLATES_DIR set to $HOME/.local/share/templates
  • XDG_VIDEOS_DIR set to $HOME/share/video

Basic directory structure for shell scripts:

  • .config/bash/config.d - bash specific .sh config scripts (autoloaded)
  • .config/shell/config.d - shell agnostic .sh config scripts (autoloaded)
  • .config/shell/profile.d - shell agnostic .sh profile environment scripts (autoloaded)
  • .config/zsh/config.d - zsh specific .zsh config scripts (autoloaded)

Files

  • Sets up basic shell scripts to allow customizations via directories (this makes sure to only load profile scripts on interactive login/non-login shells):
    • .profile - setup to autoload scripts from .config/shell/profile.d
    • .bashrc - setup to autoload scripts from .config/shell/config.d/ and .config/bash/config.d directories for any customizations
    • .bash_profile - setup to autoload scripts from .config/shell/profile.d. It also loads .profile and .bashrc
    • .zshrc - setup to autoload scripts from .config/shell/config.d/ and .config/zsh/config.d directories for any customizations. Has [antigen][30] enabled so the scripts can provide different configurations.
    • .bash_profile - setup to autoload scripts from .config/shell/profile.d. It also loads .profile and .bashrc
    • Further customizations can be done by providing custom files in any of the basic directories in your own repository.

Authors

Copyright (c) 2015-2017 ek9 [email protected] (https://ek9.co).

License

Licensed under MIT License.

shell-config's People

Contributors

ek9 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

stormwatch

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.