irongit
Sign inRegister
huncholanehuncholane/dotzshPublic
dotzsh/README.md
109 lines5.6 KBMarkdown
PreviewRawDownloadHistory
1# dotzsh
2
3Tired of reconfiguring mandatory programs over and over on new systems. This
4one line install script fixes up a system to become a developement power house.
5
6## Oneline Installer
7
8```sh
9curl -fsSL https://raw.githubusercontent.com/huncholane/dotzsh/main/install.sh | bash
10```
11
12## Table of Contents
13
14- [Programs Installed](#programs-installed)
15- [Program Details](#program-details)
16 - [Essentials](#essentials)
17 - [Rust Related](#rust-related)
18 - [Go Related](#go-related)
19- [Antidote Plugins](#antidote-plugins)
20- [Test Installer](#test-installer)
21
22## Programs Installed
23
24| Program | Installer | Description |
25|---------|-----------|-------------|
26| [base-devel](https://archlinux.org/packages/core/any/base-devel/) | System | Developer tools for arch systems (gcc/g++, make, binutils, libc headers, patch, fakeroot, pkgconf) |
27| [build-essential](https://itsfoss.com/build-essential-ubuntu/) | System | Developer tools for debian systems (gcc/g++, make, binutils, libc headers, patch, fakeroot, pkgconf) |
28| [git](https://git-scm.com/) | [System](https://git-scm.com/install/linux) | Repo management |
29| [cargo](https://doc.rust-lang.org/cargo/) | [Install Script](https://doc.rust-lang.org/cargo/getting-started/installation.html) | Used for rust, also used to install some programs |
30| [lsd](https://github.com/lsd-rs/lsd) | Cargo | Adds icons to ls |
31| [go](https://go.dev/) | [Binary](https://go.dev/doc/install) | Programming language also used to install some programs |
32| [fzf](https://github.com/junegunn/fzf) | [Git](https://github.com/junegunn/fzf) | Used in several programs to fuzzy find |
33| [lazygit](https://github.com/jesseduffield/lazygit) | [Binary](https://github.com/jesseduffield/lazygit?tab=readme-ov-file#go) | Best way to use git by far (written in go) |
34| [fnm](https://github.com/Schniz/fnm?tab=readme-ov-file#using-a-script-macoslinux) | [Install Script](https://github.com/Schniz/fnm) | Node version manager written in rust |
35| [uv](https://docs.astral.sh/uv/) | [Install Script](https://docs.astral.sh/uv/getting-started/installation/) | Python environment manager written in rust |
36| [yazi](https://yazi-rs.github.io/docs/quick-start) | [Binary](https://github.com/sxyazi/yazi/releases/tag/v26.1.22) | Miller pane tui file explorer |
37
38## Program Details
39
40### Essentials
41
42**base-devel/build-essential - Must have**
43
44Allows C/C++/Assembly programs work smoothly.
45
46**git - Repo management**
47
48Manages repos. This is used heavily for installing programs. Also used a ton as a developer.
49
50### Rust Related
51
52**cargo - Rust**
53
54Rust manager that comes with rustup. Used for installing lsd. Also used with `nightly` to install blink in nvim. Essential for rust development.
55
56**lsd - Pretty ls**
57
58Pretty ls output. Alias `l` for `ls` with icons and `ll` for `ls -l` with icons.
59
60**fnm - Node version management**
61
62Node management written in rust. A much faster version of nvm. Alias `nvm` since it is muscle memory and fnm should be used instead for performance.
63
64**uv - Python evironment management**
65
66This one is interesting. This config sets up a a python environment in
67`$HOME/.venv` and gets sourced automatically. This plays very nice with the
68`zsh-auto-switch-vertialenv` plugin. Any directory with `.venv` in it will
69automatically be sourced upon entry. It's like conda but faster and
70automatically focused on the current directory.
71
72**yazi - Miller pane tui file explorer**
73
74A file explorer that looks like the mac file explorer using miller panes. This
75one doesn't have a very good universal way to install, so the install script
76makes installation smoother by determining architecture, download from github
77release, and copy the binaries into `/usr/local/bin`.
78
79### Go Related
80
81**go - Programming language created by Google**
82
83Some of the programs are installed using go. This is installed by checking the latest version online and installing for the detected architecture. The package is untarred into `/usr/local/go` and `/usr/local/go/bin` is added to the `PATH`.
84
85**lazygit - The most incredible way to use git**
86
87A tui to represent git and all of it's beauty written and installed through go. Used heavily in tmux with `prefix-G` on [dotmux](https://github.com/huncholane/dotmux).
88
89## Antidote Plugins
90
91| Plugin | Description |
92|--------|-------------|
93| [fzf-tab](https://github.com/Aloxaf/fzf-tab) | Replace zsh tab completion with fzf |
94| [zsh-vi-mode](https://github.com/jeffreytse/zsh-vi-mode) | Vi mode for zsh |
95| [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting) | Fish-like syntax highlighting as you type |
96| [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) | Fish-like inline suggestions from history |
97| [zsh-autopair](https://github.com/hlissner/zsh-autopair) | Auto-close brackets, quotes, and parentheses |
98| [zsh-history-substring-search](https://github.com/zsh-users/zsh-history-substring-search) | Type a command and arrow up/down to search history |
99| [zoxide](https://github.com/ajeetdsouza/zoxide) | Smarter cd that learns your most-used directories |
100| [powerlevel10k](https://github.com/romkatv/powerlevel10k) | Fast, configurable zsh prompt theme |
101| [zsh-autoswitch-virtualenv](https://github.com/MichaelAquilina/zsh-autoswitch-virtualenv) | Auto-activate Python virtualenvs on cd |
102| [forgit](https://github.com/wfxr/forgit) | Interactive git commands powered by fzf |
103
104## Test Installer
105
106The `install_test.sh` file runs a docker image for ubuntu (debian) or arch
107given a parameter ubuntu or arch. It creates a user with sudo priviledge and
108symlinks install.sh to `/bin/doit`. Just start the script to enter a test
109docker container and run `doit` to try it on the container.