✦ aelyx-shell ✦

     

---

✦ Overview ✦

A shell built to get things done.

Key goals:

• Minimal, script-centric configuration
• Easy to review and selectively apply
• Composable modules for prompts, completions, and UI widgets

---

✦ Previews ✦

Desktop	Launcher

---

✦ Repository layout ✦

• /dots/ — Primary shell dotfiles (core modules)
• /dots-extra/ — Optional dotfiles, themes, and wallpapers
• /license/ — License and contributing docs
• /previews/ — Example screenshots used in this README
• /setup/ — Installer scripts and bootstrap utilities
• /.github/ — README and other stuff

---

✦ Installation (automatic recommended) ✦

Follow these steps to install the collection. The automated setup is conservative and will prompt before making destructive changes.

1. Clone the repository:

   git clone https://github.com/xZepyx/aelyx-shell.git ~/.aelyx-shell
   cd ~/.aelyx-shell

2. Inspect configuration and optional modules:

   • Review files in system/ if needed.

3. Run the installer:

   cd install && bash unified.sh

   • The installer will guide you through dependency checks and optional modules.
   • The script will either let to install the complete dotfiles or only the shell itself.

4. Open a fresh shell session or source your shell profile to apply changes.

Notes:

• Manual installation (symlinking files yourself) is supported and recommended for cautious users.
• Back up your existing dotfiles (e.g. ~/.config/ ~/.bashrc, ~/.zshrc, ~/.profile) before running the bootstrap.
• Other files under the install directory: pkg.sh, update.sh and files.sh read install/README.md.

---

✦ Configuration & customization ✦

• Primary config: ~/.local/share/aelyx/user/config.json
• Modular settings: prompt, completion, and widget modules are separated for easy replacement.
• To customize:
  • Edit the primary config or use the provided settings app (if installed).
  • Enable/disable modules by editing the module list in the ~/.config/quickshell/ae-qs/shell.qml file.

---

✦ Recommended environment ✦

• Compositor: Hyprland
• Terminal: Kitty
• Fonts: JetBrainsMono

---

✦ Troubleshooting ✦

• Missing/Unloaded Modules:
  • Ensure the module file is loaded in the correct order. Check ~/.config/quickshell/shell.qml.
• Broken visuals:
  • Check ~/.local/share/aelyx/user/config.json
• Slow startup:
  • Disable unused modules or lazy-load heavy features (e.g., prompt segments that query network/state).
• Conflicting user configs:
  • Inspect existing profile files (~/.bashrc, ~.zshrc, ~/.profile, ~/.config) before applying changes.
• Installer failures:
  • Re-run the installer with verbose output or check install/ scripts for dependency checks.
• Create issues if nothing works make sure when you create a issue including this checklist:
  • The install script completed without errors, and I did not skip or ignore any failed commands
  • My system is up to date (including aelyx-shell).
  • I am using the latest stable release of aelyx-shell (not beta/alpha/rc build)

---

✦ To-Do ✦

• Redesign config layout and widget system for improved modularity and discoverability | Done
• Add more curated optional modules and theme variants
• Improve installer prompts and backup behavior | Done
• Improve shell performance (currently a big laggy on my machine)

---

✦ Contributing ✦

Contributions are welcome. When contributing:

• Open concise issues after confirming the problem isn't caused by local configuration.
• Submit focused PRs with clear descriptions and tests where applicable.
• Follow code structure and naming conventions used in dots/.

See license/CONTRIBUTING.md for full contribution guidelines.

---

✦ Maintainer ✦

• Maintainer: xZepyx (Aditya Yadav)
• Contact: zepyxunderscore@gmail.com

---

✦ Acknowledgments ✦

• QuickShell and its contributors
• Hyprland and its developers/contributors

---

✦ License ✦

© 2025 xZepyx (Aditya Yadav) — Licensed under the MIT License. See license/ for details.

---