Skip to content

docs(configuration): improved info on config files and directories #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(configuration): improved info on config files and directories #219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions docs/src/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,25 @@ zellij setup --dump-config > ~/.config/zellij/config.kdl

## Where does Zellij look for the config file?

By default Zellij will look for `config.kdl` in the `config` directory.
By default, Zellij will look for `config.kdl` in its config directory.

Zellij will search for the `config` directory as follows:
Zellij will search for the config director in the following order:

- `--config-dir` flag
- `ZELLIJ_CONFIG_DIR` env variable
- As specified by the `--config-dir` flag
- At the path provided by the `ZELLIJ_CONFIG_DIR` environment variable
- At the default location:
- Linux: `$HOME/.config/<zellij-project-dir>` (e.g. `/home/alice/.config/zellij`)
- Mac: `$HOME/Library/Application Support/<zellij-project-dir>` (e.g. `/Users/Alice/Library/Application Support/org.Zellij-Contributors.Zellij`)\
(`<zellij-project-dir>` is specific to the Rust package, and cannot be changed by the user)
- `$XDG_CONFIG_HOME/zellij`
- `$HOME/.config/zellij`
- default location
- Linux: `/home/alice/.config/zellij`
- Mac: `/Users/Alice/Library/Application Support/org.Zellij-Contributors.Zellij`
- At the system default location (always set to `/etc/zellij` - platform-specific locations)

- system location (`/etc/zellij`)
Zellij determines the name of the configuration file in the following order:

- As specified by the `--config` flag
- `ZELLIJ_CONFIG_FILE` environment variable
- `config.kdl` if none of the above are set

## How to bypass the config file?

Expand Down