Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bill-c-martin/dot-file-manager
Track and manage Linux dot-files, symlinks, and aliases across machines.
https://github.com/bill-c-martin/dot-file-manager
aliases bash bashrc dotfiles linux
Last synced: about 1 month ago
JSON representation
Track and manage Linux dot-files, symlinks, and aliases across machines.
- Host: GitHub
- URL: https://github.com/bill-c-martin/dot-file-manager
- Owner: bill-c-martin
- Created: 2021-09-09T03:04:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T23:39:46.000Z (8 months ago)
- Last Synced: 2024-04-21T03:12:29.052Z (8 months ago)
- Topics: aliases, bash, bashrc, dotfiles, linux
- Language: Shell
- Homepage:
- Size: 51.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# dot-files
Track and manage Linux dot-files, symlinks, and aliases across machines.
Features:
- Group your aliases into group files in `includes/aliases/`
- List these aliases using the `a` pretty-print command
- Customize `~./bashrc` by adding to `config/bashrc-addons` file
- Setup dot file symlinks from your `~` into this repo using `setup.sh`
Ships with:
- Sample `.gitconfig`, `.vimrc`, and `.bashrc` files.
- You can add more to the repo's root.
- Bunch of sample aws, pacman, arch, disk, file, git, network, server, etc aliases
- You can add more to the aliases folder in their own files
## Setup
```bash
cd ~
git clone [email protected]:bill-c-martin/dot-files.git
chmod +x dot-files/setup.sh
./dot-files/setup.sh
```
The setup script asks if it can point your `~` dot files to the versions in this repo (or any other files you add to this repo starting with a `.`):
- `.gitconfig`
- `.vimrc`
- `.bashrc`
The setup script also will offer to append an include in `~/.bashrc` for this repo's aliases and `.bashrc` customizations.
From there, refresh bash:
```bash
. ~/.bashrc
```
Install `bat` for pretty-printing:
```bash
sudo apt install bat
```
## Usage
### Alias Usage
Aliases are grouped in files under `~/.dotfiles/bash/aliases/*`.
Print alias groups:
```bash
a
```
Example output:
```bash
Usage: a
Where is one of:
alias-browser
arch
aws
disk
docker
files
general
git_aliases
gnome
gw
network
pacman
permissions
server
```
View aliases for a particular `` from above output:
```bash
a
```
Example:
```bash
a pacman
```
Example output:
```bash
Aliases in /home/bill/dot-files/includes/aliases/pacman:
───────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
│ File: /home/bill/dot-files/includes/aliases/pacman
───────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
1 │ # Install/uninstall
2 │ alias pacman-install='sudo pacman -Syu' # append package name
3 │ alias pacman-uninstall='sudo pacman -Rsc' # append package name
4 │
5 │ # What do I have?
6 │ alias pacman-installed='pacman -Q'
7 │ alias pacman-installed-info='pacman -Qi' # append package name
8 │ alias pacman-orphaned='pacman -Qdt'
9 │
10 │ # Finding packages
11 │ alias pacman-search='pacman -Ss' # append package name
12 │ alias pacman-search-info='pacman -Si' # append package name
13 │
14 │ # Update/upgrade
15 │ alias pacman-update='sudo pacman -Syy'
16 │ alias pacman-upgrade='sudo pacman -Syu'
17 │
18 │ # Cache
19 │ alias pacman-clean-cache='pacman -Sc'
```
## Dot File Usage
To track a new dot file, add it to the root of this repo, then run `setup.sh` which will symlink your dot file from `~/` to the one in this repo.
### Example: Move `.gitconfig` to be Tracked in This Repo
```bash
cp ~/.vimrc ~/dot-files/.gitconfig
cd ~ && ./dot-files/setup.sh
```
Output:
```bash
# Setting up dot file symlinks..
Symlinked: ~/.gitconfig -> ~/dot-files/.gitconfig
# Next Steps:
- Refresh bash: . ~/.bashrc
- View aliases: a
```
### Example: Track a Brand New `.vimrc` File in This Repo
Where `~/.vimrc` does not yet exist.
```bash
echo "set tabstop=4 shiftwidth=4 expandtab" > ~/dot-files/.vimrc
cd ~ && ./dot-files/setup.sh
```
Output:
```bash
# Setting up dot file symlinks..
Symlinked: ~/.vimrc -> ~/dot-files/.vimrc
# Next Steps:
- Refresh bash: . ~/.bashrc
- View aliases: a
```