Skip to content
Get packs

Guide · Open source

How to use dotfiles: lewagon/dotfiles setup guide

Updated · written with AI from the project's own documentation and checked against our catalogue data

Dotfiles are configuration files, usually named with a leading dot, that set up your shell and tools. The lewagon/dotfiles repository holds default configuration for developer machines, made for students of the Le Wagon coding bootcamp. This guide explains what the repository contains, what you need before cloning it, and what you should check yourself because the README does not cover it.

dotfileslewagon/dotfiles · ★ 21.9k · MIT

Quick start

  1. 1Check prerequisites. Confirm git, zsh and oh-my-zsh are installed on your machine.
  2. 2Clone the repository. Run the git clone command from the README to download the files.
  3. 3Read the files. Open each configuration file, since the README does not explain them.
  4. 4Back up existing settings. Save your current shell configuration before applying anything.
  5. 5Apply and test. Use the files as you see fit and open a new terminal to check the result.

What does the lewagon/dotfiles repository contain?

The repository is a set of default configuration files for setting up a developer machine. The README says it is used by Le Wagon students and lists three tools as its toolset: oh-my-zsh, Visual Studio Code and git.

The README is short. It does not describe the individual files or explain the setup steps in detail, so the files themselves are the main documentation.

  • oh-my-zsh: a framework for managing the zsh shell
  • Visual Studio Code: the editor the toolset refers to
  • git: version control, which you also need to clone the repository

What do you need before you start?

The install method is clone-and-build. The listed prerequisites are git, zsh and oh-my-zsh. Install these before cloning the repository.

The README does not state which operating systems are supported, so check that your system is a Unix-like one that can run zsh before you go further.

  • git
  • zsh
  • oh-my-zsh

How do you clone the repository?

Clone the repository with git using the command from the README. This downloads the files to your machine so you can read them.

git clone https://github.com/lewagon/dotfiles

How do you apply the files safely?

The README does not describe how the files are applied to your home directory. Before you copy or link anything, open each file and read what it sets.

If you already have shell settings, back them up first. Overwriting existing configuration without a backup can change how your terminal behaves, and the README gives no uninstall or rollback steps.

  • Read each file before using it
  • Back up your existing shell configuration
  • Test changes in a new terminal session

How does this compare with other dotfile tools?

If you want a documented, general-purpose way to manage dotfiles, this repository is not that. The README has no usage guide. Comparable projects that focus on managing dotfiles include chezmoi and GNU Stow, and oh-my-zsh is a shell framework you can use on its own.

Pick chezmoi or GNU Stow if you need a documented workflow for your own dotfiles.

  • oh-my-zsh: shell framework, also listed as a prerequisite
  • chezmoi: comparable project for managing dotfiles
  • GNU Stow: comparable project for managing dotfiles

What people use it for

  • Following Le Wagon's bootcamp machine setup
  • Starting from a default oh-my-zsh and git configuration
  • Studying how a bootcamp standardizes its students' development environment

Frequently asked questions

Is lewagon dotfiles free to use?

The repository is licensed under the MIT licence, which is listed on its page. Check the licence file in the repository for the full terms.

What do I need to install before using lewagon dotfiles?

The listed prerequisites are git, zsh and oh-my-zsh. You need git to clone the repository and zsh with oh-my-zsh to use the shell configuration.

How do I install lewagon dotfiles?

Clone the repository with git clone https://github.com/lewagon/dotfiles. The README does not give further installation steps, so read the files before applying them.

Does lewagon dotfiles work on Windows?

The README does not say which platforms are supported. Because it relies on zsh and oh-my-zsh, check compatibility for your system before you install it.

Will this overwrite my existing shell settings?

The README does not describe how the files are applied. Back up your current shell configuration first so you can restore it if needed.

What is a good alternative to lewagon dotfiles?

For a documented dotfiles workflow, consider chezmoi or GNU Stow. oh-my-zsh is a separate shell framework that you can use without this repository.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Use this repository if you are a Le Wagon student following the bootcamp setup, or if you are comfortable reading shell config and want a starting point for oh-my-zsh and git. Pick chezmoi or GNU Stow if you need a documented, general-purpose dotfiles tool, because this README gives no usage guide.

Install options & downloads