dotfiles 0.2.453

Dotfiles v0.2.453

Website • Documentation • Report Bug • Request Feature • Contributing Guidelines

👋 Welcome to Dotfiles

Dotfiles are set of macOS / Linux and Windows configuration files.

Simply designed to fit your shell life

Dotfiles aggregates a collection of standalone configuration files (dotfiles) combined into a shell directory that can be used to customize your development environment across numerous computers and operating systems (macOS, Windows, Linux).

The Dotfiles provides modular configuration files (aliases, functions and paths) built for speed, higher performance, with the aim of helping you have an easy and centralized way to configure your environment and applications.

💼 Documentation

To read the documentation for Dotfiles, please visit:

Getting Started

🔧 Installation

We are so delighted that you have decided to try Dotfiles, and are sure that you will find Dotfiles unique and helpful.

Dotfiles seeks to bring you high quality and easy to use standalone and modular configuration files that can be used to customize your development environment across numerous computers and operating systems (macOS, Windows, Linux).

We understand that you may want to install Dotfiles without reading long manuals and lengthy documentation. So we have tried to make the installation process as easy as possible.

📦 Prerequisites

However, we recommend that you read the below guidelines before installing Dotfiles. A range of installation methods are available, and we recommend that you choose the one that best suits your needs.

✔️ Requirements

The following requirements are needed to install Dotfiles:

Bash - a shell, or command language interpreter, for the GNU operating system.
Or Zsh - a shell designed for interactive use, although it is also a powerful scripting language.
Git - a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.
Curl - a command line tool for transferring data with URL syntax.
Wget - a free software package for retrieving files using HTTP, HTTPS and FTP, the most widely-used Internet protocols.
Make - a tool which controls the generation of executables and other non-source files of a program from the program's source files.
Shell - a shell command line interpreter program for Unix-like operating systems.
PnPM - a package manager for JavaScript and Node.js. It is fast, disk space efficient and reliable.

1️⃣ Download Dotfiles

You can download the latest version (v0.2.453) with the following options:

Manual download - The easiest way to install Dotfiles.
Install with PnPM pnpm i -g @sebastienrousseau/dotfiles.
Install with Npm npm install -g @sebastienrousseau/dotfiles.
Install with Yarn yarn global add @sebastienrousseau/dotfiles.
Clone the main repository to get all source files including build scripts: git clone https://github.com/sebastienrousseau/dotfiles.git. This will clone the latest version of the Dotfiles repository.

2️⃣ Back Up Your Existing Data

Before installing Dotfiles, we strongly recommend that you back up your existing data. The Dotfiles installer will try to automatically backup any previous installation of known dotfiles into a backup directory $HOME/.dotfiles/backup.

The backup files are the following:

.alias
.bash_aliases
.bash_profile
.bash_prompt
.bashrc
.curlrc
.dir_colors
.exports
.functions
.gitattributes
.gitconfig
.gitignore
.gitmessage
.inputrc
.npmrc
.path
.profile
.tmux.conf
.vimrc
.wgetrc
.yarnrc
.zshenv
.zshrc
cacert.pem

After installation, you will find the backup files in the ~/dotfiles_backup directory. It is always a good idea to backup as there might be situations in which you could be required to restore your previous installation.

3️⃣ Try it out and let us know what you think

To install the latest version of the dotfiles, run the following command:

Using make (highly recommended)

Simply run the following command in your terminal / shell:

make installer

or if you want to just check the options available, run the following command:

make help

Using PnPM (recommended if you have PnPM installed)

PnPM is a key dependency of the dotfiles package. It will help you install the dotfiles rapidly and very efficiently.

pnpm installer

Post installation

Following the installation, you can verify that the dotfiles package is installed in the following directory $HOME/.dotfiles_backup.

Just quit your terminal and restart it. If the installation is successful, you should be able to see a new interface of your terminal and be able to start using the dotfiles aliases and other configurations.

Please refer to the documentation for more information.

4️⃣ What's included

Dotfiles contains core elements that are used to configure your shell, and other components catered for your environment setup.

Within the download you'll find all the Dotfiles source files grouped within the shell folder.

You'll see something like this:

.
├── aliases
│   ├── default
│   │   ├── README.md
│   │   └── default.aliases.sh    # Default aliases
│   ├── gcloud
│   │   ├── README.md
│   │   └── gcloud.aliases.sh     # GCloud aliases
│   ├── git
│   │   ├── README.md
│   │   └── git.aliases.wip       # Git aliases (WIP)
│   ├── heroku
│   │   ├── README.md
│   │   └── heroku.aliases.sh     # Heroku aliases
│   ├── jekyll
│   │   ├── README.md
│   │   └── jekyll.aliases.sh     # Jekyll aliases
│   ├── pnpm
│   │   ├── README.md
│   │   └── pnpm.aliases.sh       # PnPM aliases
│   ├── subversion
│   │   ├── README.md
│   │   └── subversion.aliases.sh # Subversion aliases
│   ├── tmux
│   │   ├── README.md
│   │   └── tmux.aliases.sh       # Tmux aliases
│   └── README.md
├── configurations
│   ├── bash
│   │   └── bashrc                # Bash configurations
│   ├── curl
│   │   ├── cacert.pem            # CA Certificates
│   │   └── curlrc                # Curl configurations
│   ├── default
│   │   ├── color.sh              # Color definitions
│   │   ├── editor.sh             # Editor definitions
│   │   └── prompt.sh             # Prompt definitions
│   ├── inputrc
│   │   └── inputrc               # Inputrc configurations
│   ├── jshint
│   │   └── jshintrc              # JSHint configurations
│   ├── profile
│   │   └── profile               # Profile configurations
│   ├── tmux
│   │   └── tmux                  # Tmux configurations
│   ├── vim
│   │   └── vimrc                 # Vim configurations
│   ├── wget
│   │   └── wgetrc                # Wget configurations
│   ├── zsh
│   │   └── zshrc                 # Zsh configurations
│   └── README.md
├── functions
│   ├── README.md
│   ├── cdls.sh                   # cdls function
│   ├── changediskpwd.sh          # changediskpwd function
│   ├── code.sh                   # code function
│   ├── countdown.sh              # countdown function
│   ├── curlheader.sh             # curlheader function
│   ├── curltime.sh               # curltime function
│   ├── encode64.sh               # encode64 function
│   ├── environment.sh            # environment function
│   ├── extract.sh                # extract function
│   ├── filehead.sh               # filehead function
│   ├── genpwd.sh                 # genpwd function
│   ├── goto.sh                   # goto function
│   ├── headers.sh                # headers function
│   ├── hidehiddenfiles.sh        # hidehiddenfiles function
│   ├── history-all.sh            # history-all function
│   ├── hostinfo.sh               # hostinfo function
│   ├── hstats.sh                 # hstats function
│   ├── httpdebug.sh              # httpdebug function
│   ├── keygen.sh                 # keygen function
│   ├── last.sh                   # last function
│   ├── logout.sh                 # logout function
│   ├── lowercase.sh              # lowercase function
│   ├── macos.sh                  # macos function
│   ├── matrix.sh                 # matrix function
│   ├── mcd.sh                    # mcd function
│   ├── mount_read_only.sh        # mount_read_only function
│   ├── myproc.sh                 # myproc function
│   ├── prependpath.sh            # prependpath function
│   ├── print.sh                  # print function
│   ├── ql.sh                     # ql function
│   ├── rd.sh                     # rd function
│   ├── remove_disk.sh            # remove_disk function
│   ├── ren.sh                    # ren function
│   ├── rm.sh                     # rm function
│   ├── rps.sh                    # rps function
│   ├── showhiddenfiles.sh        # showhiddenfiles function
│   ├── size.sh                   # size function
│   ├── stopwatch.sh              # stopwatch function
│   ├── trash.sh                  # trash function
│   ├── tree.sh                   # tree function
│   ├── uppercase.sh              # uppercase function
│   ├── uuidgen.sh                # uuidgen function
│   ├── view-source.sh            # view-source function
│   ├── vscode.sh                 # vscode function
│   ├── whoisport.sh              # whoisport function
│   └── zipf.sh                   # zipf function
├── paths
│   ├── ant
│   │   └── ant.paths.sh          # Ant paths
│   ├── default
│   │   └── default.paths.sh      # Default paths
│   ├── homebrew
│   │   └── homebrew.paths.sh     # Homebrew paths
│   ├── java
│   │   └── java.paths.sh         # Java paths
│   ├── maven
│   │   └── maven.paths.sh        # Maven paths
│   ├── node
│   │   └── node.paths.sh         # Node paths
│   ├── nvm
│   │   └── nvm.paths.sh          # Nvm paths
│   ├── pnpm
│   │   └── pnpm.paths.sh         # Pnpm paths
│   ├── ruby
│   │   └── ruby.paths.sh         # Ruby paths
│   └── tmux
│       └── tmux.paths.sh         # Tmux paths
├── README.md
├── aliases.sh                    # aliases loader
├── configurations.sh             # configurations loader
├── exit.sh                       # exit loader
├── functions.sh                  # functions loader
├── history.sh                    # history loader
└── paths.sh                      # paths loader

32 directories, 95 files

🔗 Releases

Releases are available on the GitHub releases page.

🚥 Semantic versioning policy

For transparency into our release cycle and in striving to maintain backward compatibility, Dotfiles follows Semantic Versioning (SemVer) and ESLint's Semantic Versioning Policy.

History

See Dotfiles Release list.

✅ Changelog

GitHub Releases

📖 Code of Conduct

We are committed to preserving and fostering a diverse, welcoming community. Please read our Code of Conduct.

⭐️ Our Values

We believe perfection must consider everything.
We take our passion beyond code into our daily practices.
We are just obsessed about creating and delivering exceptional solutions.

❤️ Contributing

Thank you for using Dotfiles! If you like the library, it would be great if you can give it a star ⭐ on GitHub.

There are also many ways in which you can participate in this project, for example:

Submit bugs and feature requests, and help us verify as they are checked in,
Review source code changes, and help us improve our code quality,
Review the documentation and make pull requests for anything from typos to additional and new content.

Please read carefully through our Contributing Guidelines for further details on the process for submitting pull requests to us.

🥂 License

This project is licensed under the MIT License - see the LICENSE file for details.

🏢 Acknowledgements

Dotfiles is beautifully crafted by these people and a bunch of awesome contributors


Sebastien Rousseau	Graham Colgate

Provide feedback

Saved searches

Use saved searches to filter your results more quickly