https://github.com/cyanchanges/dotfiles
My dotfiles
https://github.com/cyanchanges/dotfiles
dotfiles dotfiles-linux environment linux nushell zsh
Last synced: 10 months ago
JSON representation
My dotfiles
- Host: GitHub
- URL: https://github.com/cyanchanges/dotfiles
- Owner: CyanChanges
- Created: 2024-02-15T10:41:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-07T16:42:38.000Z (11 months ago)
- Last Synced: 2025-07-07T17:58:54.078Z (11 months ago)
- Topics: dotfiles, dotfiles-linux, environment, linux, nushell, zsh
- Language: Nushell
- Homepage:
- Size: 111 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# dotfiles
This repo contains the dotfiles of mine.
> [!IMPORTANT]
> This project is still working in progress.
> Please report any BUG in [Issues](https://github.com/CyanChanges/dotfiles/issues)
## Requirements
Make sure `stow`, and `git` is installed
before using this repo.
Because i use [arch](https://archlinux.org) btw,
use `pacman` to install.
```sh
sudo pacman -S git stow
```
To run `.zpms.py`, you need following packages:
- zsh
- python
- python-rich
- python-typer
- python-colorama
```sh
sudo pacman -S zsh python python-rich python-typer python-colorama
```
If you want to better completion,
instead of `zsh-users/zsh-completions`, install `carapace`
Because i use [arch](https://archlinux.org) btw,
use your AUR package manager (`paru`, `yay`, etc.)
to install `carapace-bin`
```sh
paru -S carapace-bin
```
## Quick Start
Please check out the [Requirements](#requirements)
Clone this repo in your `$HOME` directory using git:
```shell
git clone https://github.com/CyanChanges/dotfiles.git
cd dotfiles
```
Then, use `stow` to create symlinks:
```shell
stow .
```
Then, [Configure ZSH](#configure-zsh)
## Configure ZSH
Make sure `zsh` is installed:
```sh
sudo pacman -S zsh
```
Following packages is required too:
```zsh
paru -S gnupg zoxide lsd
```
Run `z-pms.py` (See <#Requirements> above), to choice your favourite ZSH plugin manager.
See [Choice ZSH plugin managers](#zsh-plugin-managers) for more details.
I prefer [`zinit`](https://github.com/zdharma-continuum/zinit):
```shell
./.z-pms.py
```
Enter the name to select.
Wait until the command complete,
run `zsh` to have a nice ZSH shell.
## ZSH Plugin Managers
I have configured some plugin managers out of box.
List of currently supported plugin managers and support status:
- [zinit](https://github.com/zdharma-continuum/zinit) **Recommended**
- [zimfw](https://github.com/zimfw/zimfw) **Good**
- [zplug](https://github.com/zplug/zplug) **Fair**
- [zpm](https://github.com/zpm-zsh/zpm) **Working In Progress**
## Completions
## Dev environment
I use [mise](https://mise.jdx.dev/) to configure my dev environment
```shell
paru -S mise
```