Simply designed to fit your shell life 🐚
• Website • Documentation • Report Bug • Request Feature • Contributing Guidelines
Dotfiles are a powerful set of configuration files for macOS, Linux, and Windows providing scripts and customized settings to streamline your workflow. These files are an essential tool for developers and users who want to modify their environment and applications to their exact needs.
The Dotfiles library are combined into a single lib
directory. This
directory allows you to easily setup your development environment across
numerous computers and operating systems, ensuring consistency and
productivity no matter where you work.
We are so delighted that you have decided to try Dotfiles, and are sure that you will find Dotfiles unique and helpful.
To get started, please follow the instructions below. If you have any questions, please feel free to contact us.
We understand that you may want to install Dotfiles without reading long manuals and lengthy documentation. In that respect, we have tried to make the installation process as easy and automated as possible.
A range of installation methods are available, and we recommend that you choose the one that best suits your needs.
Before you begin your installation, use this information to ensure that you meet all the hardware, software, and system requirements for installing Dotfiles.
You need a modern operating system to install Dotfiles. Here's an non- exhaustive list of the recommended operating systems that we support.
If you don't see your operating system listed, it may still work, but we have yet been able to test it. If you have any issues, please let us know.
The following programs must be installed on your system to install Dotfiles:
We recommend using a font such as Roboto Mono for Powerline
for
terminal and vscode editor.
On macOS, you can install the font using the following command:
brew tap homebrew/cask-fonts
brew install --cask font-roboto-mono-for-powerline
On Linux, you can install the font using the following command:
sudo apt install fonts-roboto-mono-for-powerline
To read the documentation for Dotfiles, please visit:
You can download the latest version (v0.2.468) with the following options:
pnpm i @sebastienrousseau/dotfiles
.npm install @sebastienrousseau/dotfiles
.yarn add @sebastienrousseau/dotfiles
.git clone https://github.com/sebastienrousseau/dotfiles.git
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
It is always a good idea to backup as there might be situations in which you could be required to restore your previous installation.
To install the latest version of the dotfiles, run the following command:
The easiest way to install Dotfiles is to use the make
command. This
will install the latest version of the dotfiles and will automatically
backup any existing dotfiles you may have into a backup directory
$HOME/dotfiles_backup
.
The installer will check if you have PnPM installed to switch to the PnPM installation method. If not, it will fallback to equivalent shell scripts.
Switch to the dist
directory and run:
make build
You can also just check the installer options available, by simply running:
make help
If you want to install Dotfiles using Node.js, you can run the following
command in the dist
directory located in your
node_modules/@sebastienrousseau/dotfiles/dist
directory:
node .
This will install the latest version of the dotfiles and will
automatically backup any existing dotfiles you may have into a backup
directory $HOME/dotfiles_backup
.
PnPM is a key dependency of the dotfiles package. It will help you install the dotfiles rapidly and very efficiently.
Switch to the dist
directory and run:
pnpm run build
This will install the latest version of the dotfiles and will
automatically backup any existing dotfiles you may have into a backup
directory $HOME/dotfiles_backup
.
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.
Releases are available on the GitHub releases page.
For transparency into our release cycle and in striving to maintain
backward compatibility, Dotfiles
follows
Semantic Versioning.
We are committed to preserving and fostering a diverse, welcoming community. Please read our Code of Conduct.
We welcome contributions to Dotfiles
. Please see the
contributing guidelines for more information.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).