ZSHRC

🛠️ ZSHRC – Interactive Zsh Setup & Tooling

Welcome 👋
This project helps you set up a powerful Zsh-based development environment in a safe, modular, and explainable way.

It is designed for:

Developers setting up a new machine
Engineers who want control over what gets installed
Anyone tired of copy-pasting random dotfiles

Getting Started
What This Project Does
How It Works
Common Commands
Modules Overview
Shell Setup (Zsh)
Troubleshooting
Resources

✨ What This Project Does

This repository provides an interactive setup system that lets you:

Install tools like zsh, tmux, fzf, and more
Apply .zshrc and .tmux.conf safely
Understand dependencies between tools
Preview changes before installing
Run the setup multiple times without breaking your system

Nothing is installed silently. Everything is explicit.

🧠 How It Works

Each tool or configuration is treated as a module
Modules declare their dependencies
The installer resolves dependencies automatically
If something is skipped or missing, dependent modules are skipped safely
Configuration files are always updated with backups

You can explore this visually using the dependency graph.

🟢 Getting Started

One-line Install (Recommended)

curl -fsSL https://raw.githubusercontent.com/jatingarg36/ZSHRC/main/install.sh | bash

Manual Install (Git Clone)

git clone https://github.com/jatingarg36/ZSHRC
cd ZSHRC
chmod +x setup.sh

Run the setup (recommended)

./setup.sh

This launches an interactive menu where you choose what to install.

⚡ Common Commands

Install everything (non-interactive)

./setup.sh --yes

Preview without installing (dry run)

./setup.sh --dry-run

Install specific modules

./setup.sh tmux fzf config

Visualize dependency graph

./setup.sh --graph

Explain a module

./setup.sh --explain tmux

🧩 Modules Overview

Some of the key modules included:

zsh: Z shell
ohmyzsh: Zsh framework
p10k: Powerlevel10k theme
tmux: Terminal multiplexer
fzf: Fuzzy finder
zsh-autosuggestions: Fish-like autosuggestions
zsh-syntax-highlighting: Syntax highlighting
config: Installs .zshrc, .tmux.conf, and base directories

You can list all available modules anytime:

./setup.sh --list

🐚 Shell Setup (Zsh)

For safety reasons, the installer does not change your default shell automatically.

If you explicitly want to switch your default shell to Zsh:

./setup.sh --set-shell

Or as part of full setup:

./setup.sh --yes --set-shell

After that, restart your terminal or run:

exec zsh

🧪 CI / Automation Safety

In CI environments (GitHub Actions, GitLab CI, containers):

Shell changes are automatically skipped
The installer never fails because of chsh

This makes the project safe for automation.

🧯 Troubleshooting

“My shell is still bash”

This is expected. Run:

./setup.sh --set-shell

“Nothing changed after re-running setup”

Try:

./setup.sh config

Config modules always re-apply updates with backups.

🔗 Resources

Useful links to understand the tools used here:

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md.