Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudlena/dotfiles
:unicorn: My personal dotfiles
https://github.com/cloudlena/dotfiles
bash dotfiles tmux vim zsh
Last synced: about 2 hours ago
JSON representation
:unicorn: My personal dotfiles
- Host: GitHub
- URL: https://github.com/cloudlena/dotfiles
- Owner: cloudlena
- License: gpl-3.0
- Created: 2015-06-01T20:51:51.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T11:17:59.000Z (7 months ago)
- Last Synced: 2024-04-08T12:32:35.613Z (7 months ago)
- Topics: bash, dotfiles, tmux, vim, zsh
- Language: Lua
- Homepage:
- Size: 8.54 MB
- Stars: 75
- Watchers: 4
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dotfiles
:unicorn: My personal dotfiles
> [!WARNING]
> Since I'm using [NixOS](https://nixos.org/) now, these dotfiles have been superseeded by my [Nixfiles](https://github.com/cloudlena/nixfiles) and are not maintained anymore.
I mainly work with [Go](https://golang.org), [Rust](https://www.rust-lang.org), [JavaScript](https://en.wikipedia.org/wiki/JavaScript), [TypeScript](https://www.typescriptlang.org), [Markdown](https://en.wikipedia.org/wiki/Markdown) and [shell scripts](https://en.wikipedia.org/wiki/Shell_script) so my setup is geared towards working with these technologies.
Supported operating systems are macOS and Arch Linux (and its derivates).
## Features and Usage
### Terminal
This setup uses a powerful combination of [Alacritty](https://github.com/jwilm/alacritty), [tmux](https://github.com/tmux/tmux) and [zsh](https://www.zsh.org/) with a minimalistic prompt.
### Commands
- `pacu`: Update and upgrade the whole system (using `Brewfile` on macOS and `pacmanfile` on Arch Linux)
- `depu`: Update and upgrade the dependencies for the current project
- `mkcd`: Create a directory and enter it
- `fcd`: cd into a directory using fuzzy search
- `fe`: Edit a directory or file using fuzzy search
- `fco`: Checkout Git branches or tags using fuzzy search
- `fkill`: Kill any process with fuzzy search
- `fshow`: Git commit browser with fuzzy search
### Text Editor
Text editing is based on [Neovim](https://neovim.io/), configured to be an "IDE". The entire setup with all plugins can also be run as a [container](https://github.com/cloudlena/vide).
- `e`: Start Neovim with all plugins
- `ide`: Start Neovim with all plugins in an IDE like window layout
#### Navigation
- `gd`: Go to definition of symbol under cursor
- `gi`: Go to implementations of symbol under cursor
- `gr`: Go to references of symbol under cursor
- ``: Fuzzy search files in workspace
- `/`: Fuzzy search in all files in workspace
- `j`: Open visual file explorer
#### Git
- `gg`: Git status
- `gd`: Git diff
- `gb`: Git blame
- `gs`: Git stage current hunk
- `gu`: Git unstage current hunk
- `gc`: Git commit
- `gm`: Git three-way merge
#### Diagnostics and Refactoring
- `K`: Show signature of symbol under cursor
- `[d`: Go to previous diagnostic issue
- `d]`: Go to next diagnostic issue
- `e`: Show diagnostics details
- `s`: Open workspace diagnostics
- `k`: Open symbols outline of file
- `r`: Rename current symbol
- `a`: Display code actions
#### Testing
- `tn`: Run nearest test to cursor
- `tf`: Run all tests in file
- `ta`: Run all tests
- `tu`: Toggle extended testing UI
#### Debugging
- `db`: Toggle breakpoint on current line
- `dB`: Set condition for breakpoint
- `dd`: Start debugger or continue to next breakpoint
- `dn`: Step over
- `di`: Step into
- `do`: Step out
- `dK`: Show evaluation of symbol under cursor
- `du`: Toggle extended debugging UI
#### Add Languages and Tools
To extend the editor with new languages and tools, simply add them to [`tools.lua`](./nvim/.config/nvim/lua/config/tools.lua).
## Installation
1. Clone this repo to `~/dotfiles` by running `git clone [email protected]:cloudlena/dotfiles.git ~/dotfiles`
1. Change the name and email address in `git/.config/git/config`
1. Arch Linux only: Change `pacmanfile/.config/pacmanfile/pacmanfile.txt` to your liking or add `pacmanfile-extra.txt` to the same directory for independent packages per machine
1. macOS only: Change `Brewfile` to your liking or add `extra.Brewfile` for independent packages per machine
1. macOS only: If you have apps installed which you didn't install through `brew` but that you now added to `Brewfile`, you need to reinstall them with `brew install --force`, so `brew` knows it's supposed to manage these apps.
Note: This won't delete any of your data. The app will just be reinstalled with `brew` and everything will be back to normal once the installation script has run.
1. Run `~/dotfiles/install.sh`
**WARNING: This may install and/or remove software and change your configs!**
1. Either import an existing PGP key pair by using `gpg --import my-key.asc` and `gpg --import my-key-pub.asc`, or create a new one by following the [GitHub guide](https://help.github.com/en/articles/generating-a-new-gpg-key). You need to use the same name and email address as an ID that you have configured in `git/.gitconfig` to correctly sign your Git commits.
1. Either import an existing SSH key pair by copying it to `~/.ssh/id_rsa` and `~/.ssh/id_rsa.pub` or create a new one by following the [GitHub guide](https://help.github.com/en/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
## Quick Installation without customization (not recommended unless you're the owner of this repo :wink:)
1. Run the following command:
**WARNING: This may install and/or remove software and change your configs!**
```shell
$ curl -s https://raw.githubusercontent.com/cloudlena/dotfiles/main/install.sh | sh
```