Dotfiles

Easily manage and synchronize your dotfiles across multiple environments with the Dotfiles project, streamlining your development setup and CI/CD pipeline.

• Documentation: https://dotfiles.entelecheia.ai
• GitHub: https://github.com/entelecheia/dotfiles

The Dotfiles project offers a comprehensive solution for managing and synchronizing your dotfiles across various environments, including local development, CI/CD pipelines, and production systems. With this tool, you can effortlessly maintain a consistent development environment, simplifying collaboration and reducing the time spent on setting up new machines. The Dotfiles project uses the Chezmoi framework, providing a secure and flexible way to manage your configuration files. The project also includes support for additional integrations, such as Docker, GitHub repositories, and password management tools, further enhancing your development experience. Get started with the Dotfiles project today and enjoy a seamless, hassle-free configuration management process.

Getting started

The following guide will walk you through the process of installing and initializing the Dotfiles project on your machine. This will help you set up a consistent development environment across different systems, simplifying your workflow and making it easier to collaborate with others.

Prerequisites

Before proceeding with the installation, ensure that your system has the following tools:

• wget or curl: To fetch the installation script from the internet.
• git: To clone the Dotfiles repository.

Most Linux distributions come with these tools pre-installed. If not, you can install them using your package manager.

Installing Dotfiles

To install the Dotfiles project on your machine, you need to fetch the installation script and execute it. You can do this using either wget or curl:

Using wget:

sh -c "$(wget -qO- https://dotfiles.entelecheia.ai/install)"

Using curl:

sh -c "$(curl -fsSL https://dotfiles.entelecheia.ai/install)"

Running the above command will download the installation script and execute it, cloning the Dotfiles repository to your machine and setting up the necessary configurations.

For unattended installations such as in a dockerfile, you can use the environment variables to initialize the dotfiles automatically. For example:

# install dotfiles
ARG USER_FULLNAME="John Doe"
ARG USER_EMAIL="[email protected]"
ARG GITHUB_USERNAME="john-doe"
ARG SYSTEM_HOSTNANE="devcon-arm64"

ENV USER_FULLNAME=$USER_FULLNAME
ENV USER_EMAIL=$USER_EMAIL
ENV GITHUB_USERNAME=$GITHUB_USERNAME
ENV SYSTEM_HOSTNAME=$SYSTEM_HOSTNAME
ENV WORKSPACE_LOCATION="/"
ENV DOTFILES_APPLY_ROOTMOI=0
ENV REMOTE_CONTAINERS=1

RUN sh -c "$(wget -qO- https://dotfiles.entelecheia.ai/install)"

CMD ["zsh"]

Or you can provide the environment variables in the command line:

USER_FULLNAME="John Doe" \
USER_EMAIL="[email protected]" \
GITHUB_USERNAME="john-doe" \
SYSTEM_HOSTNAME="devcon-arm64" \
WORKSPACE_LOCATION="/" \
DOTFILES_APPLY_ROOTMOI=0 \
REMOTE_CONTAINERS=1 \
sh -c "$(wget -qO- https://dotfiles.entelecheia.ai/install)"

Initializing Dotfiles

After the installation, the initialization process will start automatically. This step applies the configurations defined in your dotfiles to your system, ensuring a consistent development environment.

If you need to re-initialize your dotfiles manually, you can run the following command:

dotu init

This command will update your system with the latest configurations from your dotfiles, keeping your environment up-to-date and in sync with any changes you've made.

Once the initialization process is complete, you can start using your newly configured development environment. Feel free to explore the available configurations and customize them to your preferences.

Repositories and repository templates for setting up your own dotfiles

• dotdrop-files
• password-store
• passage-store

Installing the font on Windows

1. Download Fira Code Regular Nerd Font Complete.
2. Open the downloaded file and click Install.
3. Restart Windows Terminal or VS Code.

Configuring the font in VS Code

1. Open settings by pressing Ctrl/Cmd+,.
2. Change the font family to FiraCode Nerd Font in Terminal › Integrated: Font Family.

Configuring the font in Windows Terminal

1. On Windows Terminal, press Ctrl+, to open the settings.
2. Go to Profiles -> Defaults in the left panel. Then, go to Additional settings -> Appearance.
3. At Text -> Font face, enable the Show all fonts option and select FiraCode Nerd Font. Like below:

Changelog

See the CHANGELOG for more information.

Contributing

Contributions are welcome! Please see the contributing guidelines for more information.

License

This project is released under the MIT License.