Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/musq/dotfiles
🏵️ Bash scripts to set up local environment as a developer
https://github.com/musq/dotfiles
debian dotfiles gnupg macos nix ssh ubuntu
Last synced: 12 days ago
JSON representation
🏵️ Bash scripts to set up local environment as a developer
- Host: GitHub
- URL: https://github.com/musq/dotfiles
- Owner: musq
- License: gpl-3.0
- Created: 2019-07-24T17:29:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-03T20:01:23.000Z (9 months ago)
- Last Synced: 2024-07-05T09:36:57.539Z (4 months ago)
- Topics: debian, dotfiles, gnupg, macos, nix, ssh, ubuntu
- Language: Shell
- Homepage:
- Size: 250 KB
- Stars: 5
- Watchers: 1
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Ashish’s dotfiles
[](https://travis-ci.org/musq/dotfiles)
[](https://github.com/musq/dotfiles/releases/latest)
[](https://github.com/semantic-release/semantic-release)
[](https://github.com/RichardLitt/standard-readme)
These are the base configurations that I start with when I set up a
new environment.
`sudo` is **not required**.
---
**BEWARE** — This tool modifies your local configurations.
**Proceed with caution.**
**DO NOT** run the `setup.sh` script if you don't fully understand
[what it does](src/os/setup.sh).
Seriously, **DON'T**!
---
## Table of Contents
- [Background](#background)
- [Requirements](#requirements)
- [Install](#install)
- [One-line installer](#one-line-installer)
- [Manual](#manual)
- [Update](#update)
- [Non-Interactive](#non-interactive)
- [Screenshots](#screenshots)
- [Acknowledgements](#acknowledgements)
- [Contributing](#contributing)
- [License](#license)
## Background
Manually setting up a usable environment on a brand new machine is
always a tiring experience. I felt the need to create a tool which
would automate this process as smoothly as possible. It should ideally —
- Work without `sudo`
- Perform some hardening operations
- Install necessary tools
- Manage local configurations
It should also **follow these standards** —
- Bootstrap itself using only `wget` or `curl`
- Be idempotent
- Be easy to audit
## Requirements
This tool is only meant for Linux variants. It has been verified to
work on —
- Debian 9
- Ubuntu 16.04+
- MacOS Mojave+ (Nix might not work on some packages)
It is **strongly recommended** to use
[dotfiles-system](https://github.com/musq/dotfiles-system) to install
[`Nix`](https://nixos.org/nix) beforehand.
## Install
The setup process will:
- Download the dotfiles on your computer (by default it will suggest
`~/projects/dotfiles`)
- Take versioned [backup](src/os/create_backup.sh) of files that might
be changed and store them in `~/.backups/dotfiles-backup/v*`
- [Symlink](src/os/create_symbolic_links.sh) the [`config`](src/config),
[`gnupg`](src/gnupg), [`shell`](src/shell), and [`ssh`](src/ssh) files
- [Harden](src/os/contract/harden.sh) `ssh` and `gnupg` direcories
- [Install](src/os/install/nix) packages using `Nix`
- Set custom [`macOS`](src/os/preferences/macos),
[`Debian/Ubuntu`](src/os/preferences/debian) preferences
- Install [`fonts`](src/os/contract/fonts.sh),
[`tmux plugins`](src/os/install/helpers.sh), and
[`vim plugins`](src/os/contract/vim.sh)
### One-line installer
| Tool | Snippet |
|:---|:---|
| `wget` | `bash -c "$(wget -qO - https://raw.githubusercontent.com/musq/dotfiles/master/src/os/setup.sh)"` |
| `cURL` | `bash -c "$(curl -LsS https://raw.githubusercontent.com/musq/dotfiles/master/src/os/setup.sh)"` |
### Manual
```bash
# Clone this repo
git clone https://github.com/musq/dotfiles.git
# Go inside
cd dotfiles
# Run installer
./src/os/setup.sh
```
### Update
```bash
# Go inside the project repo
cd path/to/dotfiles
# Update git repo
git pull origin master
# Run installer
./src/os/setup.sh
```
### Non-Interactive
Pass `-y` or `--yes` to automatically answer yes to all the questions.
| Tool | Snippet |
|:---|:---|
| `Manual` | `./src/os/setup.sh -y` |
| `wget` | `bash -c "$(wget -qO - https://raw.githubusercontent.com/musq/dotfiles/master/src/os/setup.sh) -y"` |
| `cURL` | `bash -c "$(curl -LsS https://raw.githubusercontent.com/musq/dotfiles/master/src/os/setup.sh) -y"` |
## Screenshots
### Install in action
### Previews
Fuzzy directory jump
List git branches
Git log
Git reflog
Git diff (unified)
Git icdiff (side-by-side)
Fuzzy git log with preview
Tmux
## Acknowledgements
Inspiration and code were taken from many sources, including:
- [Cătălin's dotfiles](https://github.com/alrra/dotfiles)
- [Bluz71's dotfiles](https://github.com/bluz71/dotfiles)
- [Whiteinge's dotfiles](https://github.com/whiteinge/dotfiles)
## Contributing
Feel free to dive in!
[Open an issue](https://github.com/musq/dotfiles/issues/new)
or submit PRs.
See [contributing guidelines](CONTRIBUTING.md).
If you decide to **fork this project**, do not forget to substitute my
username with your own in the
[`one-line installer`](#one-line-installer) and in the
[`setup script`][setup line]
## License
- The code is available under [GNU GPL v3, or later](LICENSE) license
- Parts taken from other sources are still available under their
original licenses
[setup line]: blob/master/src/os/setup.sh#L3