guangzhiyao/myzsh
1
0
Fork 0
mirror of https://github.com/guangzhiyao/myzsh.git synced 2026-04-09 16:30:05 +00:00
Code Issues Projects Releases Packages Wiki Activity
personalized zsh setup
27 commits 1 branch 0 tags 79 KiB
Find a file
Exact
Jonathan Hiltel d0365f06ea Simplify Atuin config and update Starship theme 
Prune verbose Atuin settings to a minimal, privacy-first set:
set compact style, fuzzy search and global filtering; keep auto_sync
disabled, enable enter_accept and inline_height, enable show_stats,
and add theme = "marine"

Overhaul Starship prompt: new layout and palette (catppuccin_mocha),
rework module styles/formats, add language modules, cmd_duration,
character/line_break modules, and multiple color palettes
2026-02-01 10:34:34 +01:00
.zshrc Replace Powerlevel10k with Starship and Atuin 2026-02-01 09:14:31 +01:00
atuin.toml Simplify Atuin config and update Starship theme 2026-02-01 10:34:34 +01:00
LICENSE Replace Powerlevel10k with Starship and Atuin 2026-02-01 09:14:31 +01:00
README.md Add --install-font option and update README 2026-02-01 09:29:36 +01:00
setup_zsh.sh Handle '-s' installer invocation and preserve '--' 2026-02-01 10:05:33 +01:00
starship.toml Simplify Atuin config and update Starship theme 2026-02-01 10:34:34 +01:00

README.md

myzsh

A small, opinionated Zsh setup that installs:

  • Zsh + Oh-My-Zsh
  • Starship prompt
  • Atuin shell history
  • Useful Zsh plugins (zsh-autosuggestions, zsh-syntax-highlighting)

This repository provides a hardened, idempotent installer script: ./setup_zsh.sh.

Prerequisites

  • Debian-based system (apt) is the primary target
  • git and either curl or wget available

Quick install

git clone https://github.com/guangzhiyao/myzsh
cd myzsh
chmod +x setup_zsh.sh
./setup_zsh.sh

Important installer behaviour

  • --dry-run shows actions without making changes.
  • --clean / --force performs a clean install (replaces configs).
  • --install-font enables an optional best-effort Nerd Font download (disabled by default; useful only on UI/dev machines).
  • Existing user files are backed up with timestamps by default; --clean removes targets before copying.
  • The installer downloads remote installers to temporary files for audit before execution.
  • If an Atuin configuration already exists at ~/.config/atuin/config.toml, the shipped config will be skipped unless --clean is used (to avoid duplicate TOML keys).

Post-install

  • Restart your shell or run: exec zsh
  • User configuration files written/modified:
    • ~/.zshrc
    • ~/.config/starship.toml
    • ~/.config/atuin/config.toml (only when not present or when using --clean)

Notes & recommendations

  • The installer assumes a Debian/apt environment. On other distros, run steps manually or adapt the script.
  • If you want the provided configs but prefer to merge manually, consider copying atuin.toml to ~/.config/atuin/config.toml.example and merging by hand.
  • Verify starship and atuin behavior after install (e.g., starship explain, atuin --version).

License See the LICENSE file in this repository.