Files kelve keeps
What kelve keeps on your computer, and where.
The data folder
kelve’s data folder is ~/.config/kelve, or under XDG_CONFIG_HOME when it’s set. On Windows, it’s %APPDATA%\kelve. KELVE_DATA names another. kelve makes the folder so only you can read it.
| File | What’s in it |
|---|---|
kelve.db | kelve’s store: what it read, what it marked, pages read plainly, entries your agent wrote, what you’ve read, your settings |
secret | The secret the command line and your agent’s tools use. kelve won’t use one others can read |
secret.key | The key that seals the shared graph’s key before it’s kept |
kelve.log | kelve’s log, when it runs in the background |
notes/ | Your own notes, until you choose a folder for them |
With another shared graph, kelve keeps a store of its own for it, such as kelve-off.db with none. So changing back finds everything as it was. Before an update changes the store, kelve copies it aside, as kelve.db.before- and the time. It keeps the last two.
Your notes folder
Your notes folder holds your notes, and the notes you leave your agent. They’re plain Markdown files, in a folder for each project. It also holds marks.md, what kelve marks for you. Your notes folder is the data folder’s notes/ until you choose one.
In a project: .kelve/
| Path | What’s in it |
|---|---|
.kelve/notes/ | Notes kept with the work, and what your agent found out for you |
.kelve/read/ | What’s read, when Keep what’s read in the repo is on |
.kelve/way.json | The project’s way in, and each folder’s line, when what’s read is kept in the repo |
Commit .kelve/ with the work, so the people you work with have it too. kelve never counts it as part of a change.
What kelve reads
kelve reads a folder as git does, so it leaves out what .gitignore leaves out. To leave out more, list it in a .kelveignore in the project, written the same way:
notes/
drafts/*.mdkelve never reads files that may hold secrets, whatever you list. These include names like .env, .envrc, .netrc, .npmrc, .pgpass, credentials.json, secrets.yml or id_rsa. They also include endings like .pem, .key, .p12, .kdbx, .ovpn, .tfstate or .tfvars. An example with no secrets in it, such as .env.example, is read.
kelve lists these, but never reads them:
- Lockfiles.
- Licences.
- Minified files.
- What a tool made, in folders such as
dist/orgen/. - Someone else’s code kept in the project, such as
node_modules/orvendor/. - Files over a megabyte.
kelve masks secrets in the files it does read, as it reads them.