Skip to content

Configuration

Create a config file at ~/.config/zk/config.cue:

root_path: "~/zk_vault"
index_path: ".zk_index"
graph_path: ".zk_graph.db"
editor: "nvim"
folders: {
untethered: "untethered"
tethered: "tethered"
tmp: "tmp"
}
OptionDefaultDescription
root_path~/zk_vaultRoot directory for all notes
index_path.zk_indexLocation of Bleve search index (relative to root)
graph_path.zk_graph.dbLocation of persistent graph database (relative to root)
todos_path.zk_todosDirectory for generated todo lists (relative to root)
editornvimEditor for opening notes
folders.untethereduntetheredSubdirectory for untethered notes
folders.tetheredtetheredSubdirectory for tethered notes
folders.tmptmpSubdirectory for temporary notes