Skip to content

Configuration

When running the CLI, place .nefaxer.toml in the directory you index. File values are defaults; command-line flags override them.

The library uses NefaxOpts directly — no automatic TOML load unless you parse it yourself.

Example .nefaxer.toml

toml
[settings]
db_path = ".nefaxer"
hash = true
follow_links = false
exclude = ["node_modules", ".git"]
list = false
verbose = false
mtime_window = 0
strict = false
paranoid = false
encrypt = false

Settings

KeyTypeDescription
db_pathstringIndex file path (default .nefaxer in DIR)
hashboolCompute Blake3 (--check-hash)
follow_linksboolFollow symlinks
excludearray of stringsGlob patterns to skip
listboolList changed paths on diff (--list)
verboseboolVerbose output / progress
mtime_windowintegerMtime tolerance in seconds
strictboolFail on first access error
paranoidboolRe-hash on mtime/size mismatch when hashing
encryptboolSQLCipher-encrypted index

Passphrase (encrypt)

When encrypt = true, use --encrypt / -x on the CLI. Passphrase from prompt, NEFAXER_DB_KEY, or .env.

UBLX note

UBLX maintains its own per-root SQLite under the user cache (ubli/). Nefaxer’s .nefaxer format is the same family of metadata; UBLX drives indexing through the library. See UBLX integration.

UBLX · Nefaxer · ZahirScan