Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/renemarc/dotfiles

~/. Cross-platform, cross-shell configuration files. ⚙️💻
https://github.com/renemarc/dotfiles
bash chezmoi cross-platform dotfiles macos multiple-machines powershell windows zsh
Last synced: about 2 months ago
JSON representation
~/. Cross-platform, cross-shell configuration files. ⚙️💻
Host: GitHub
URL: https://github.com/renemarc/dotfiles
Owner: renemarc
License: mit
Created: 2019-12-16T18:49:36.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-03-14T08:05:22.000Z (over 1 year ago)
Last Synced: 2024-05-30T02:53:25.994Z (4 months ago)
Topics: bash, chezmoi, cross-platform, dotfiles, macos, multiple-machines, powershell, windows, zsh
Language: Shell
Homepage:
Size: 237 KB
Stars: 189
Watchers: 7
Forks: 23
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

jimsghstars - renemarc/dotfiles - ~/. Cross-platform, cross-shell configuration files. ⚙️💻 (Shell)
README

        


    ~/. 📂
Cross-platform, cross-shell dotfiles
 ^{_{powered by  chezmoi 🏠}}



[![Codacy rating][badge-codacy]][link-codacy]

[![CodeFactor rating][badge-codefactor]][link-codefactor]

[![License][badge-license]][link-license]

[![Repo analytics][badge-analytics]][link-analytics]

[![Tweet][badge-twitter]][link-twitter]

Universal command set and colourful shell configurations for Bash, Zsh and Powershell, compatible with macOS, Windows and (partially) Linux, all managed easily using [chezmoi](https://github.com/twpayne/chezmoi).



    Be sure to ⭐️ or 🔱 this repo if you find it useful! 😃



## Project goals ⚽

-   Unified set of aliases and commands.

-   Familiar feel and creature comforts across environments.

-   Cross-platform file management toolset.

-   Easy access to common paths.

-   Shortcuts to popular cross-platform apps.

-   System-agnostic `update` and `dotfiles` install commands.

-   A pretty interface! 💃

🔝


## Supported toolset 🛠️

Use either one or many of these, the config files will be in place and ready to provide a familiar interface.

### 🐚 Shells

-   [Bash](https://www.gnu.org/software/bash/) _^🐧: [`~/.bashrc`](./dot_bashrc) _^{enhanced with [**Bash-It**](https://github.com/Bash-it/bash-it)!}_

-   [PowerShell 5.1+](https://github.com/PowerShell/PowerShell) _^🐧⊞: [`~/.config/powershell/`](./dot_config/powershell/) _^{enhanced with [**Oh-My-Posh**](https://github.com/JanDeDobbeleer/oh-my-posh), [**Terminal Icons**](https://github.com/devblackops/Terminal-Icons), and others!}_

-   [Z shell](http://zsh.sourceforge.net/) _^🐧: [`~/.zshrc`](./dot_zshrc) _^{enhanced with [**Oh-My-Zsh**](https://ohmyz.sh/), [**Powerlevel10K**](https://github.com/romkatv/powerlevel10k), and others!}_

### 💻 Terminals

-   [Hyper](https://hyper.is/) _^🐧⊞: [`~/.hyper.js`](./dot_hyper.js.tmpl)

-   [iTerm2](https://iterm2.com/) : [`~/.config/iterm/`](./dot_config/iterm)

-   [macOS Terminal](https://support.apple.com/en-ca/guide/terminal/welcome/mac) 

-   [Windows Terminal](https://www.microsoft.com/en-us/p/windows-terminal-preview/9n0dx20hk701) ⊞: [`~/.config/windows_terminal/`](./dot_config/windows_terminal)

### 📦 Package managers

-   [Homebrew](https://brew.sh/) : [`~/.Brewfile`](./dot_Brewfile)

-   [Scoop](https://scoop.sh/) ⊞

### 💾 Universal apps ^_🐧⊞

-   [chezmoi](https://www.chezmoi.io/) dotfiles manager: [`~/.chezmoi.toml`](./.chezmoi.toml.tmpl)

-   [cURL](https://curl.haxx.se/) data transfer tool: [`~/.curlrc`](./dot_curlrc)

-   [Git :octocat:](https://git-scm.com/) version-control system: [`~/.gitconfig`](./dot_gitconfig.tmpl)

-   [GNU Nano 4.x+](https://www.nano-editor.org/) text editor: [`~/.nanorc`](./dot_nanorc) _^{enhanced with [**Improved Nano Syntax Highlighting Files**](https://github.com/scopatz/nanorc)!}_

-   [GNU Wget](https://www.gnu.org/software/wget/) HTTP/FTP file downloader: [`~/.wgetrc`](./dot_wgetrc)

-   [Micro](https://micro-editor.github.io/) text editor: [`~/.config/micro/`](./dot_config/micro)

-   [OpenSSH](https://www.openssh.com/) secure networking utilities: [`~/.ssh/config`](./dot_ssh/config.tmpl)

-   [Ripgrep](https://github.com/BurntSushi/ripgrep) fast-search tool: [`~/.ripgreprc`](./dot_ripgreprc)

-   [SQLite3](https://www.sqlite.org/cli.html) database client: [`~/.sqliterc`](./dot_sqliterc)

-   [Starship 🚀](https://starship.rs) cross-shell prompt: [`~/.config/starship.toml`](./dot_config/starship.toml)

-   [tmux](https://github.com/tmux/tmux/wiki) terminal multiplexer: [`~/.tmux.conf.local`](./dot_tmux.conf.local) _^{enhanced with [**Oh-My-Tmux**](https://github.com/gpakosz/.tmux)!}_

-   [Vim](https://www.vim.org/) text editor: [`~/.vimrc`](./dot_vimrc) _^{enhanced with [**Ultimate vimrc**](https://github.com/amix/vimrc)!}_

🔝


## Cross-shell compatibility matrix 🏁

These are unified CLI commands available amongst different shells on all platforms. While some of their outputs may differ in style between different environments, their usage and behaviours remain universal.

Additional aliases are provided by [Bash-It](https://github.com/Bash-it/bash-it/tree/master/aliases/available), [Oh-My-Zsh](https://github.com/ohmyzsh/ohmyzsh/wiki/Cheatsheet) and [Powershell](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_aliases), and are listed by using the command `alias`.

System-specific aliases are marked with , ⊞, or _^🐧.

### 🧭 Easier navigation

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅ | `~`      | Navigates to user home directory. |

| ✅   | ✅         | ✅ | `cd-`    | Navigates to last used directory. |

| ✅   | ✅         | ✅ | `..`
`cd..` | Navigates up a directory. |

| ✅   | ✅         | ✅ | `...`    | Navigates up two directories. |

| ✅   | ✅         | ✅ | `....`   | Navigates up three directories. |

| ✅   | ✅         | ✅ | `.....`  | Navigates up four directories. |

🔝


### 🗂️ Directory browsing

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `l`     | Lists visible files in long format. |

| ✅   | ✅         | ✅  | `ll`    | Lists all files in long format, excluding `.` and `..`. |

| ✅   | ✅         | ✅  | `lsd`    | Lists only directories in long format. |

| ✅   | ✅         | ✅  | `lsh`   | Lists only hidden files in long format. |

🔝


### 🗄️ File management

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `cpv`   | Copies a file securely. |

| ✅   | ✅         | ✅  | `fd`    | Finds directories. |

| ✅   | ✅         | ✅  | `ff`    | Finds files. |

| ❌   | ✅         | ❌  | `mirror` | Mirrors directories. |

| ✅   | ✅         | ✅  | `rg`    | Searches recursively with [ripgrep](https://github.com/BurntSushi/ripgrep). |

🔝


### 💡 General aliases

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `alias` | Lists aliases. |

| ✅   | ✅         | ✅  | `c`     | Clears the console screen. |

| ✅   | ❌         | ✅  | `extract`
`x` | Extracts common file formats.
_Usage: `extract solarized.zip`_ |

| ✅   | ✅         | ✅  | `h`     | Displays/Searches global history.
_Usage: `h`_
_Usage: `h cd`_ |

| ✅   | ✅         | ⚠️  | `hs`    | Displays/Searches session history.
_Usage: `hs`_
_Usage: `hs cd`_ |

| ✅   | ✅         | ✅  | `mkcd`
`take` | Creates directory and change to it.
_Usage: `mkcd foldername`_ |

| ✅   | ❌         | ✅  | `reload` | Reloads the shell. |

| ✅   | ✅         | ✅  | `repeat`
`r` | Repeats a command `x` times.
_Usage: `repeat 5 echo hello`_. |

| ✅   | ❌         | ✅  | `resource` | Reloads configuration. |

🔝


### 🕙 Time

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `now`
`unow` | Gets local/UTC date and time in [ISO 8601](https://xkcd.com/1179/) format `YYYY-MM-DDThh:mm:ss`. |

| ✅   | ✅         | ✅  | `nowdate`
`unowdate` | Gets local/UTC date in `YYYY-MM-DD` format. |

| ✅   | ✅         | ✅  | `nowtime`
`unowtime` | Gets local/UTC time in `hh:mm:ss` format. |

| ✅   | ✅         | ✅  | `timestamp` | Gets Unix time stamp. |

| ✅   | ✅         | ✅  | `week`  | Gets week number in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Week_dates) format `YYYY-Www`. |

| ✅   | ✅         | ✅  | `weekday` | Gets weekday number. |

🔝


### 🌐 Networking

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `fastping` | Pings hostname(s) 30 times in quick succession. |

| ✅   | ✅         | ✅  | `flushdns` | Flushes the DNS cache. |

| ✅   | ✅         | ✅  | `ips`   | Gets all IP addresses. |

| ✅   | ✅         | ✅  | `localip` | Gets local IP address. |

| ✅   | ✅         | ✅  | `publicip` | Gets external IP address. |

| ✅   | ✅         | ✅  | `GET`
`HEAD`
`POST`
`PUT`
`DELETE`
`TRACE`
`OPTIONS` | Sends HTTP requests.
_Usage: `GET https://example.com` |_

🔝


### ⚡ Power management

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `hibernate` | Hibernates the system. |

| ✅   | ✅         | ✅  | `lock`  | Locks the session. |

| ✅   | ✅         | ✅  | `poweroff` | Shuts down the system. |

| ✅   | ✅         | ✅  | `reboot` | Restarts the system. |

🔝


### 🤓 Sysadmin

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `mnt`   | Lists drive mounts. |

| ✅   | ✅         | ✅  | `path`  | Prints each `$PATH` entry on a separate line. |

| ✅   | ✅         | ✅  | `sysinfo` | Displays information about the system.
^{Uses either [Winfetch](https://github.com/lptstr/winfetch), [Neofetch](https://github.com/dylanaraps/neofetch), or [Screenfetch](https://github.com/KittyKatt/screenFetch).} |

| ✅   | ✅         | ✅  | `top`   | Monitors processes and system resources.
^{Uses either [atop](https://linux.die.net/man/1/atop), [htop](https://hisham.hm/htop/), [ntop](https://github.com/Nuke928/NTop) ⊞, or native.} |

| ✅   | ✅         | ✅  | `update` | Keeps all apps and packages up to date. |

🔝


### 🖥️ Applications

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `browse` | Opens file/URL in default browser.
_Usage: `browse https://example.com`_ |

| ✅   | ✅         | ✅  | `chrome` | Opens file/URL in [Chrome](https://www.google.com/chrome/). |

| ✅   | ✅         | ✅  | `edge` | Opens file/URL in [Microsoft Edge](https://www.microsoft.com/en-us/edge). |

| ✅   | ✅         | ✅  | `firefox` | Opens file/URL in [Firefox](https://www.mozilla.org/en-CA/firefox/). |

| ❔   | ✅         | ❔  | `iexplore` | Opens file/URL in [Internet Explorer](https://www.microsoft.com/ie). ⊞ |

| ✅   | ✅         | ✅  | `opera` | Opens file/URL in [Opera](https://www.opera.com/). |

| ✅   | ✅         | ✅  | `safari` | Opens file/URL in [Safari](https://www.apple.com/ca/safari/).  |

| ✅   | ✅         | ✅  | `ss`    | Enters the [Starship 🚀](https://starship.rs) cross-shell prompt. |

| ✅   | ✅         | ✅  | `subl`
`st`  | Opens in [Sublime Text](https://www.sublimetext.com/). |

🔝


### 👩‍💻 Development

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `dk`    | 🐳 Alias for [`docker`](https://www.docker.com/). |

| ✅   | ✅         | ✅  | `dco`   | 🐳 Alias for [`docker-compose`](https://docs.docker.com/compose/). |

| ✅   | ✅         | ✅  | `g`     | :octocat: Alias for [`git`](https://git-scm.com/). |

| ✅   | ✅         | ✅  | `va`    | 🐍 Activates Python [virtual environment `venv`](https://docs.python.org/3/tutorial/venv.html). |

| ✅   | ✅         | ✅  | `ve`    | 🐍 Creates Python [virtual environment `venv`](https://docs.python.org/3/tutorial/venv.html). |

🔝


###  macOS

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `hidedesktop`
`showdesktop` | Toggles display of desktop icons. |

| ✅   | ✅         | ✅  | `hidefiles`
`showfiles` | Toggles hidden files display in [Finder](https://support.apple.com/en-ca/HT201732). |

| ✅   | ✅         | ✅  | `spotoff`
`spoton` | Toggles [Spotlight](https://support.apple.com/en-ca/HT204014). |

🔝


### ⊞ Windows

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ❔   | ✅         | ❔  | `hidefiles`
`showfiles` | Toggles hidden files display in [File Explorer](https://support.microsoft.com/en-ca/help/4026617/windows-10-windows-explorer-has-a-new-name). |

🔝


### 📁 Common paths

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `dls`   | Navigates to `~/Downloads`. |

| ✅   | ✅         | ✅  | `docs`  | Navigates to `~/Documents`. |

| ✅   | ✅         | ✅  | `dt`    | Navigates to `~/Desktop`. |

🔝


### 📁 Configuration paths

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `chezmoiconf` | Navigates to [Chezmoi](https://www.chezmoi.io/)'s local configuration repo. |

| ✅   | ✅         | ✅  | `powershellconf` | Navigates to [Powershell](https://github.com/PowerShell/PowerShell)'s profile location. |

| ✅   | ✅         | ✅  | `sublimeconf` | Navigates to [Sublime Text](https://www.sublimetext.com/)'s local configuration repo. |

🔝


### 📁 Custom paths

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `archives` | Navigates to `~/Archives`. |

| ✅   | ✅         | ✅  | `repos` | Navigates to `~/Code`. |

🔝


### 🌱 Varia

| Bash | PowerShell | Zsh | Command | Description |

|:----:|:----------:|:---:|---------|-------------|

| ✅   | ✅         | ✅  | `cb`    | 📋 Copies contents to the clipboard. |

| ✅   | ✅         | ✅  | `cbpaste` | 📋 Pastes the contents of the clipboard. |

| ✅   | ✅         | ✅  | `md5sum` | #️⃣ Calculates MD5 hashes. |

| ✅   | ✅         | ✅  | `sha1sum`  | #️⃣ Calculates SHA1 hashes. |

| ✅   | ✅         | ✅  | `sha256sum` | #️⃣ Calculates SHA256 hashes. |

| ✅   | ✅         | ✅  | `forecast` | 🌤️ Displays [detailed weather and forecast](https://wttr.in/?n). |

| ✅   | ✅         | ✅  | `weather` | 🌤️ Displays [current weather](https://wttr.in/?format=%l:+(%C)+%c++%t+[%h,+%w]). |

🔝


## Inspirations 💡

-   [Digital Ocean: What are your favorite bash aliases?](https://www.digitalocean.com/community/questions/what-are-your-favorite-bash-aliases)

-   [GitHub: dotfiles](http://dotfiles.github.io/)

-   [GitHub: Jay Harris' Windows dotfiles](https://github.com/jayharris/dotfiles-windows)

-   [GitHub: Jan Moesen's dotfiles](https://github.com/janmoesen/tilde)

-   [GitHub: Mathias Bynens' dotfiles](https://github.com/mathiasbynens/dotfiles)

-   [nixCraft: 30 Handy Bash Shell Aliases For Linux / Unix / Mac OS X](https://www.cyberciti.biz/tips/bash-aliases-mac-centos-linux-unix.html)

🔝


Don't forget to ⭐️ or 🔱 this repo! 😃
_{Assembled with ❤️ in Montréal.}


[badge-analytics]:https://img.shields.io/badge/repo%20analytics-public-informational?logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9HcmFwaGljcy9TVkcvMS4xL0RURC9zdmcxMS5kdGQiPjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgdmVyc2lvbj0iMS4xIiB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZD0iTTIxIDhDMTkuNSA4IDE4LjcgOS40IDE5LjEgMTAuNUwxNS41IDE0LjFDMTUuMiAxNCAxNC44IDE0IDE0LjUgMTQuMUwxMS45IDExLjVDMTIuMyAxMC40IDExLjUgOSAxMCA5QzguNiA5IDcuNyAxMC40IDguMSAxMS41TDMuNSAxNkMyLjQgMTUuNyAxIDE2LjUgMSAxOEMxIDE5LjEgMS45IDIwIDMgMjBDNC40IDIwIDUuMyAxOC42IDQuOSAxNy41TDkuNCAxMi45QzkuNyAxMyAxMC4xIDEzIDEwLjQgMTIuOUwxMyAxNS41QzEyLjcgMTYuNSAxMy41IDE4IDE1IDE4QzE2LjUgMTggMTcuMyAxNi42IDE2LjkgMTUuNUwyMC41IDExLjlDMjEuNiAxMi4yIDIzIDExLjQgMjMgMTBDMjMgOC45IDIyLjEgOCAyMSA4TTE1IDlMMTUuOSA2LjlMMTggNkwxNS45IDUuMUwxNSAzTDE0LjEgNS4xTDEyIDZMMTQuMSA2LjlMMTUgOU0zLjUgMTFMNCA5TDYgOC41TDQgOEwzLjUgNkwzIDhMMSA4LjVMMyA5TDMuNSAxMVoiIGZpbGw9IiNmZmZmZmYiIC8+PC9zdmc+&maxAge=86400

[badge-codacy]:https://app.codacy.com/project/badge/Grade/30eb39e1eb414295bcc3713755d57b1a

[badge-codefactor]:https://img.shields.io/codefactor/grade/github/renemarc/dotfiles?logo=codefactor&logoColor=white&cacheSeconds=300

[badge-license]:https://img.shields.io/github/license/renemarc/dotfiles.svg?logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9HcmFwaGljcy9TVkcvMS4xL0RURC9zdmcxMS5kdGQiPjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgdmVyc2lvbj0iMS4xIiB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZD0iTTE3LjgsMjBDMTcuNCwyMS4yIDE2LjMsMjIgMTUsMjJINUMzLjMsMjIgMiwyMC43IDIsMTlWMThINUwxNC4yLDE4QzE0LjYsMTkuMiAxNS43LDIwIDE3LDIwSDE3LjhNMTksMkMyMC43LDIgMjIsMy4zIDIyLDVWNkgyMFY1QzIwLDQuNCAxOS42LDQgMTksNEMxOC40LDQgMTgsNC40IDE4LDVWMThIMTdDMTYuNCwxOCAxNiwxNy42IDE2LDE3VjE2SDVWNUM1LDMuMyA2LjMsMiA4LDJIMTlNOCw2VjhIMTVWNkg4TTgsMTBWMTJIMTRWMTBIOFoiIGZpbGw9IiNmZmZmZmYiIC8+PC9zdmc+Cg==&maxAge=86400

[badge-twitter]:https://img.shields.io/twitter/url/http/shields.io.svg?style=social&maxAge=86400

[link-analytics]:https://repo-analytics.github.io/renemarc/dotfiles

[link-codacy]:https://www.codacy.com/gh/renemarc/dotfiles/dashboard

[link-codefactor]:https://www.codefactor.io/repository/github/renemarc/dotfiles

[link-license]:LICENSE.txt

[link-twitter]:https://twitter.com/intent/tweet?text=Cross-platform%2C%20cross-shell%20%23dotfiles%20using%20%23chezmoi&url=https://github.com/renemarc/dotfiles&via=renemarc&hashtags=Bash,PowerShell,ZSH
Ecosyste.ms: Awesome

https://github.com/renemarc/dotfiles

Awesome Lists containing this project

README

~/. 📂Cross-platform, cross-shell dotfiles powered by chezmoi 🏠

~/. 📂
Cross-platform, cross-shell dotfiles
^{_{powered by chezmoi 🏠}}
