Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
keystroke3 committed Sep 20, 2024
1 parent 2de1934 commit 23c8df9
Show file tree
Hide file tree
Showing 5 changed files with 96 additions and 51 deletions.
58 changes: 40 additions & 18 deletions .aliases
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
#

wgc(){
if [ "$1" == "d" ]; then
if [ "$1" = "d" ]; then
profile=$(ip a | grep POINTOPOINT | cut -d':' -f2 | tr -d ' ')
sudo wg-quick down $profile
return 0
fi
profile=$(ls ~/wireguard/ --color=never | fzf)
profile=$(ls /etc/wireguard/ --color=never | fzf)
if [ -n profile ];then
sudo wg-quick up $( echo $profile | cut -d'.' -f1)
fi
Expand Down Expand Up @@ -60,10 +60,20 @@ o(){
}

cfg(){
fuzz=$(rg -j 4 --no-ignore --files ~/.config | fzf --reverse --height 40%)
fuzz=$(fs -p ~/dotfiles/ -p ~/dotfiles/.config/| fzf --reverse --height 40%)
[ -f "$fuzz" ] && ([ -n "$1" ] && $1 "$fuzz" || vim "$fuzz") || return 0
}

vsc(){
fuzz=$(fs -d -p ~/dev -p ~/work -i node_modules | fzf --reverse --height 40%)
[ -d "$fuzz" ] && ([ -n "$1" ] && $1 "$fuzz" || code --ozone-platform=wayland "$fuzz") || return 0
}

ovim(){
fuzz=$(fs -d -p ~/dev -p ~/work -i node_modules/ | fzf --reverse --height 40%)
[ -d "$fuzz" ] && nvim --cmd "cd $fuzz" "$fuzz" || return 0
}

pj(){
fuzz=$(fd -t d . $HOME/Projects | fzf --reverse --height 40%)
if [ -z $fuzz ]
Expand Down Expand Up @@ -156,7 +166,7 @@ remind(){
esac
done
(sleep $delay && notify-send "$note" &&
mpv /usr/share/sounds/freedesktop/stereo/service-login.oga) &> /dev/null & disown
mpv --force-window=no /usr/share/sounds/freedesktop/stereo/service-login.oga) &> /dev/null & disown
}
ytd(){
a=
Expand Down Expand Up @@ -214,7 +224,7 @@ hclient(){
}

localip(){
ip a | grep 192.168 | cut -d ' ' -f6 | cut -d '/' -f1
ip a | grep -E '192.168|10.0' | cut -d ' ' -f6 | cut -d '/' -f1
}
ignore() {
curl -sLw "\n" "https://www.toptal.com/developers/gitignore/api/$@" | grep -v 'http' > .gitignore
Expand All @@ -230,7 +240,11 @@ mvshuffle(){
mpv --shuffle "$HOME/Videos/Music Videos/" & disown
}

# end functions
godoc(){
go doc $1 | bat --language=go
}

# functions


alias lp="l -p"
Expand All @@ -246,20 +260,14 @@ alias cronhelp=" echo '
# * * * * * <command to execute>
'"

#alias exa="ls"
alias ovim="/usr/bin/vim"
alias vim="nvim"
#alias ls="exa --color=always --group-directories-first"
#alias ll="exa -l --color=always --group-directories-first"
#alias lla="exa -al --color=always --group-directories-first"
#alias la="exa -a --color=always --group-directories-first"
alias kc="kdeconnect-cli -d edd439448e1817fa "$1""
alias move="find . -mindepth 2 -type f -print -exec mv {} . \;"
alias g="| grep"
# alias rfile="grep "$1" /home/ted/Documents/teams/teamfiles"
alias rcopy="rclone copy --progress --no-traverse"
alias rdir="cat /home/ted/Documents/teams/teamdirs | fzf"
alias bp="bpython"
alias bp="py -m bpython"
alias pkg="paru -Q | fzf"
alias gd="go doc"
alias fzf="fzf --layout=reverse --height=40%"
Expand Down Expand Up @@ -314,11 +322,13 @@ alias gcm="git checkout main"
alias gcd="git checkout dev"
alias gcs="git checkout staging"
alias gam="git add \*migrations\*"
alias gtm="git commit -m"
alias gcon="git diff --name-only --diff-filter=U"
# alias gmm="git merge "$1" -m "$(git log -1 --pretty=%B $1)""
alias start="sudo systemctl start"
alias stop="sudo systemctl stop"
alias restart="sudo systemctl restart"
alias sysenable="sudo systemctl enable"
alias pipm="python3 -m pip"
alias pyserv="python -m http.server"
alias crontab="export VISUAL=nvim; crontab"
Expand All @@ -345,16 +355,15 @@ alias dstage="ssh dino-stage"
alias dprod="ssh dino-prod"
alias cvr="coverage run --omit='*/.virtualenvs/*,*/tests_/*' manage.py test "$1""
alias cvs="coverage html"
alias ls="exa --color=always --group-directories-first"
alias ll="exa -l --color=always --group-directories-first"
alias lla="exa -al --color=always --group-directories-first"
alias la="exa -a --color=always --group-directories-first"
alias ls="eza --color=always --group-directories-first"
alias ll="eza -l --color=always --group-directories-first"
alias lla="eza -al --color=always --group-directories-first"
alias la="eza -a --color=always --group-directories-first"
alias dshell="py manage.py shell"
alias dbshell="py manage.py dbshell"
alias mpn="mpv --no-resume-playback"
alias cp="cp -r"
alias rr="exec ${SHELL} -l; clear"
alias arco="ssh [email protected]"
alias pc="[ -n $1 ] && sudo netstat -tulnp | grep $1"
alias nu=" ~/Carousel/scripts/netusage/netusage.sh"
alias uctl="systemctl --user"
Expand Down Expand Up @@ -395,5 +404,18 @@ alias rsn="npm run serve"
alias rns="npm run serve"
alias h="cat ~/.zhistory | fzf "
alias kmarial="mariadb --defaults-file=~/.local/mariadb/local.db.cnf"
alias smarial="mariadb --defaults-file=~/work/kupiku/Shipping2/ship.cnf"
alias kmariap="mariadb --defaults-file=~/.local/mariadb/prod.db.cnf"
alias wrandr='wlr-randr'
alias kp='cd "$(fs -p ~/work/kupiku/ -d --depth=1 | fzf)"'
alias vpnr="sudo protonvpn d && sudo protonvpn c -cc $1"
alias vpn="sudo protonvpn c --cc"
alias vpnd="sudo protonvpn d"
alias reflect="sudo reflector --latest 20 --sort rate --save /etc/pacman.d/mirrorlist"
alias suspend="sudo systemctl suspend"
alias currencies="smarial -e 'select * from shipping_currencyconversion'"
alias orderstatus="smarial -e 'select * from shipping_orderstatus;'"
alias gears="vkcube"
alias code="code --ozone-platform=wayland"
alias nvc="nvim --cmd \"cd ~/.config/nvim\" ~/.config/nvim"
alias lf="yazi"
3 changes: 1 addition & 2 deletions .config/hypr/keybinds.conf
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ bind = SUPER SHIFT, Print, exec, grimblast --freeze copysave output && notify-s
bind = SUPER SHIFT, X, exec, $colorpicker
bind = SUPER, Return, exec, $term
bind = SUPER, E, exec, $files
bind = SUPER, D, exec, killall rofi || rofi -show drun -theme ~/.config/rofi/config.rasi
bind = SUPER, period, exec, killall rofi || rofi -show emoji -emoji-format "{emoji}" -modi emoji -theme ~/.config/rofi/global/emoji
bind = SUPER, period, exec, killall fuzzel || fuzzel -show emoji -emoji-format "{emoji}" -modi emoji -theme ~/.config/fuzzel/global/emoji
bind = SUPER SHIFT, B, exec, pgrep waybar && killall waybar; waybar & disown
# bind = SUPER, B, exec, killall -SIGUSR1 waybar # Hide waybar
bind = SUPER, Space, exec, $menu
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ zsh/
!.config/screenshots
!.config/sxhkd
!.config/vim
!.config/nvim
.config/vim/plugged
!.config/wallpapers
!.config/yay
Expand Down
85 changes: 55 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,61 +4,86 @@ This repo contains my most frequently used config files. If you use the same pro
then they may be useful to you. Please make sure you read through the config files to know if
they will be useful to you and what you may want to change.

![Colorful Theme Desktop](https://github.com/keystroke3/dotfiles/blob/master/screenshots/Colorful%20Theme%20shot2.png?raw=true)
**Colorful Theme**
![Colorful Theme Hyprland](./screenshots/hyprland-colorful.png)
**Colorful Theme Hyprland**

![Stripes Theme Desktop](https://raw.githubusercontent.com/keystroke3/dotfiles/master/screenshots/Stripes%20Desktop.png)
**Stripes Theme**
![Colorful Theme Hyprland](./screenshots/hyprland-colorful-desktop.png)
**Colorful Theme Hyprland Desktop**

![Kitty/Prompt](https://raw.githubusercontent.com/keystroke3/dotfiles/master/screenshots/kitty.png)
Kitty with Powerlevel10k themed prompt.

![ranger](https://raw.githubusercontent.com/keystroke3/dotfiles/master/screenshots/ranger.png)
![Colorful Theme Desktop BSPWM](https://github.com/keystroke3/dotfiles/blob/master/screenshots/Colorful%20Theme%20shot2.png?raw=true)
**Colorful Theme BSPWM**

## Prerequisites
Before you attempt to install these dots, you must first make sure your system is ready. Otherwise
they may not work as intended.
#### Polybar
If you choose to use my polybar configs, you can find them in my [Carousel Repo](https://github.com/keystroke3/Carousel)

#### Fonts
For a basic install, you will need to have [Powerline](https://github.com/powerline/powerline) and [Font Awesome](https://github.com/FortAwesome/Font-Awesome) which will work fine for most of the
symbols to be visible. There are however, some widgets in polybar that will not load properly
and I would highly recommend getting the [Nerd Fonts](https://github.com/ryanoasis/nerd-fonts) and Noto Fonts packages. For polybar specifically, the necessary
fonts are `UbuntuMono Nerd` and `Noto Fonts Symbols`. These can be installed individually or as part of the previously
mentioned packages.
Terminals use `JetBrainsMono Nerd` so make sure that is also installed.

#### Colors
Colors are not that important to get right and you can go with whatever color scheme you wish. To manage
and control colors I use a [Pywal](https://github.com/dylanaraps/pywal). This program can be used to generate colors schemes and palettes which can
and control colors I use a [Pywal (Archved)](https://github.com/dylanaraps/pywal). This program can be used to generate colors schemes and palettes which can
the be integrated into other programs like terminals and Polybar. It is not a must you use it, but if you
want a consistent color scheme throughout your setup, it is recommended to use it.

#### Shell
I had used Bash since I began using Linux, and had been told many great things about Zsh. After using it
I can now say that I am a firm believer in Zsh. If you are still using Bash, you can use the bash files that
#### Zsh
I have here, but keep in mind that the screenshots you see are all with Zsh. The outcome will therefor not look exactly the same.
For my Zsh install I use [Oh-My-Zsh](https://github.com/ohmyzsh/ohmyzsh) to manage my configuration. Visit their Wiki to find out how to use it. To get the prompt
bling, you will need a theme called [Powerlevel10k](https://github.com/romkatv/powerlevel10k). This is a reimplementation of the Powerlevel9k theme with a few additions to it.
You can view their respective Wikis to find out how to install them. If you already have 9k, you can just "upgrade" to 10k:
For my Zsh install I used to use [Oh-My-Zsh](https://github.com/ohmyzsh/ohmyzsh) to manage my configuration. I now just use my own dots since they are now mature and do everything I want them to. Visit their Wiki to find out how to use it.
I use [Starship](https://starship.rs/) for the prompt with basically no modifications. The default works fine for me and is easy to re-deploy on other machines.

#### Polybar
I only use polybar BSPWM. I have not used BSPWM in over a year two years, but if you choose to use my polybar configs, you can find them in my [Carousel Repo](https://github.com/keystroke3/Carousel)

>For Powerlevel9k users
If you've been using Powerlevel9k before, **do not remove the configuration options**. Powerlevel10k
will pick them up and provide you with the same prompt UI you are used to. Powerlevel10k recognized
all configuration options used by Powerlevel9k. See Powerlevel9k
[configuration guide](https://github.com/Powerlevel9k/powerlevel9k/blob/master/README.md#prompt-customization).
To go beyond the functionality of Powerlevel9k, type `p10k configure` and explore the unique styles
and features Powerlevel10k has to offer. You can further customize your prompt by editing
`~/.p10k.zsh`.
#### Waybar
Since I use Hyprland, I use [Waybar](https://github.com/Alexays/Waybar) instead of Polybar. The font I am using is a paid font called Miriam Vaez, so I can't share freely.

#### Vim
There's nothing much going on with Vim. The only extra thing you need [Plugged](https://github.com/junegunn/vim-plug). This will
allow you to get the plugins that are in `.vimrc`. I am not using Powerline status here but [vim-airline](https://github.com/vim-airline/vim-airline) instead.
#### NeoVim
![Neovim in action](./screenshots/hyprland-neovim-bat.png)
I use [KickStart.nvim](https://github.com/nvim-lua/kickstart.nvim) with [my fork](https://github.com/keystroke3/kickstart.nvim). I don't use the nvim configs here and I can't be bothered to remove them.

#### Wallpaper
The full resolution wallapper by Alx can be found on [wallhaven](https://wallhaven.cc/w/1pzdvw). I stretched it a bit since it looked a bit squished despite being very high resolution.

## Apps
I will try to list all the things I use here, but I can't grantee that the list is up to date or that it includes everything. These are the ones I interact with on a daily basis

- Os
- Arch Linux
- WM
- Hyprland
- Waybar
- Fuzzel (rofi alternative for wayland)
- wlogout
- [Hyprman](https://github.com/keystroke3/hyprman) (work in progress)
- Thunar
- [FileSurf](https://github.com/keystroke3/FileSurf) (better for piping into things)
- Hyprpicker
- Grimblast with satty (flameshot alternative)

- Misc
- Alacritty
- Kitty
- KDE Connect
- Yazi (TUI file manager)
- Firefox
- Fzf (for my fuzzy finding needs)
- Copyq
- Easyeffects
- Solarr
- Thunderbird
- NeoVim
- VSCode
- [Tauon](https://tauonmusicbox.rocks/)

#### Icons
You may notice that file names have been prepended by small icons. This does not come by default to get the icons, you will need to use a tool called `lsd` which is a replacement for the traditional `ls` command. You can find out about how to install and use it in the [here](https://github.com/Peltoche/lsd)


## Installation
If you have all things set up correctly, you can start copying the files. First, clone the repo:
`git clone https://github.com/keystroke3/dotfiles.git`
After cloning, you can copy the files to their respective locations and then logout and log back in to apply changes.

Binary file added screenshots/hyprland-neovim-bat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 23c8df9

Please sign in to comment.