Skip to main content

Module config

Module config 

Source
Expand description

Your preferences on this machine — which index to open, the repositories this machine indexes, and how your ledger records are named and signed — kept in a versioned LanceDB table in comindly’s config folder. A TOML file of the same shape can be imported and exported. What an index runs with is stored with the index; a server keeps its settings in its database.

Precedence, highest first: CLI flag → environment variable → these preferences → default.

Structs§

Config
Non-secret preferences, all optional.
Imported
What an import changed.
RepoEntry
A repository to index: the folder of its clone and, for one comindly keeps itself, the URL it is cloned from when the folder is missing.

Enums§

Setting
A setting to write: a string, a flag or a number; Remove deletes the key.

Constants§

KEYS
The preferences, by the names files and comindly config set use.

Functions§

adopt_file
An older config.toml is imported once and renamed; one that appears later is pointed out.
adopt_legacy
Fill what team leaves unset from settings an older config.toml held; true if any.
cache_dir
$XDG_DATA_HOME/comindly, else ~/.local/share/comindly: the default index and managed clones. comindly’s cache folder on this machine: worktrees, verified signatures.
config_dir
comindly’s config folder.
config_path
Where older versions kept preferences as a file; imported once if found.
data_dir
default_index_dir
The default index location: the data folder itself.
env
An environment variable, if set.
env_token
Signature checks with this machine’s allowed_signers. The deployment’s token for host: GH_TOKEN/GITHUB_TOKEN for github.com, GITLAB_TOKEN for gitlab.com and the hosts in COMINDLY_GITLAB_HOSTS (or their _FILE).
expand_tilde
Expand a leading ~ to $HOME; leave URIs (s3://…) and absolute paths untouched.
expanded
repos with ~ in their paths expanded.
export
The preferences as a TOML file that import reads back.
git_credentials
Git tokens for indexing: on a server the ones stored there, then the deployment’s.
history
Every saved version of the preferences, newest first.
import
Import a preferences file. Without overwrite it fills only what is unset; with it, the file replaces the preferences. Index settings older files carried move to the index once.
index_settings
The settings an index runs with here: its shared settings, then this machine’s.
llm_client
An LLM client for settings, with the key for team from this machine or server.
local_allowed_signers
COMINDLY_ALLOWED_SIGNERS → allowed_signers → git gpg.ssh.allowedSignersFile.
local_identity
Who this machine records as: a pseudonymous actor id, and a name unless names are switched off (COMINDLY_AUTHOR_NAME → author_name → git user.name).
local_signing_key
This machine’s signing key: COMINDLY_SIGNING_KEY → signing_key → git user.signingkey when gpg.format=ssh.
local_verifier
save_team
Save an index’s shared settings as you, if nobody saved since expected.
set_repos
Replace the repository list.
store_path
Where the preferences are kept: <config folder>/settings.
stored
The stored preferences with their version.
ui_token
The web UI’s access token for browsers: created once, so bookmarks keep working.
update
Apply changes to the stored preferences.