https://github.com/vncsmyrnk/zsh-config
My zsh config
https://github.com/vncsmyrnk/zsh-config
oh-my-zsh zsh
Last synced: 4 months ago
JSON representation
My zsh config
- Host: GitHub
- URL: https://github.com/vncsmyrnk/zsh-config
- Owner: vncsmyrnk
- License: gpl-3.0
- Created: 2024-07-09T13:27:49.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-02-08T14:09:55.000Z (4 months ago)
- Last Synced: 2025-02-08T14:27:39.507Z (4 months ago)
- Topics: oh-my-zsh, zsh
- Language: Shell
- Homepage:
- Size: 89.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# My zsh config
This is my local config for using the [zsh](https://www.zsh.org/) shell.
For plugins and themes, [Oh My Zsh](https://ohmyz.sh/) is used.
## Directory linking
- `bin` is mapped to `$HOME/.local/bin`
- `completion` is mapped to `$ZSH/custom/completions`
- `utils` is mapped to `$HOME/utils`
- `.zshrc` and `.zprofile` are mapped to `$HOME`
[stow](https://www.gnu.org/software/stow/) is used for creating the symbolic links.
## Usage
_zsh scripts_ stored in the `utils` folder must be executable via `util` command. Example:
```bash
util file # Will source `home/utils/file.zsh` if exists
```
The `util` command should have autocomplete features.
`.zprofile` and `.zshrc` are configuration files. To apply, just `source` them.
## Install
This project uses [just](https://github.com/casey/just) and [stow](https://www.gnu.org/software/stow/) for the installation.
```bash
just install
```
Considering `zsh` is already installed, you can just run:
```bash
just config
```
> [!IMPORTANT]
> - Make sure to run `just config-delete` before updating. Then, run `just config` on the new config.
> - Extra zsh config will be sourced from `~/.zshrc.private`. Use it as a sensitive form of `.zshrc`.