Configuration
wwid has two configuration files: the user config and the
roots mapping. They are both written in the
TOML format, and are expected to be in the standard
config directory for your system. On most Linux systems, this will be
~/.config/wwid/. See
BaseDirs
for more details.
User Config
This file is called config.toml, is safe to sync across machines, and has the
following keys:
| Key | Type | Default | Description |
|---|---|---|---|
editor | String | Unset | Program that will be used for interactive editing. This is prioritized over $EDITOR if it’s set. |
extension | String | Unset | Sets the extension of the temporary file opened by the editor. Consider setting this if you want your editor to provide syntax highlighting or other language-specific features, such as a Markdown preview. |
root-globs | List of Strings | .git and .hg | A list of globs used to identify the root during project discovery. |
# A sample config.toml with settings changed
editor = "kak"
extension = "md"
root-globs = [".git", ".venv", "Cargo.toml"]
Roots
This file is called roots.toml, and is not safe to sync across machines.
The root config does not have set keys; instead, it holds a mapping of project
IDs to absolute paths. For example, if you created a project at
/foo/bar, your roots.toml may look like this:
bar-1 = "/foo/bar"
You can see all your project IDs with wwid projects list. And don’t worry,
this file is automatically created and updated as you initialize projects. Its
purpose is to allow the same project to be stored at different locations
across machines.
If you don’t intend to sync your notes, you won’t need to edit this file.