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.
- Repo
Entry - 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;
Removedeletes the key.
Constants§
- KEYS
- The preferences, by the names files and
comindly config setuse.
Functions§
- adopt_
file - An older
config.tomlis imported once and renamed; one that appears later is pointed out. - adopt_
legacy - Fill what
teamleaves unset from settings an olderconfig.tomlheld;trueif 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 forhost:GH_TOKEN/GITHUB_TOKENfor github.com,GITLAB_TOKENfor gitlab.com and the hosts inCOMINDLY_GITLAB_HOSTS(or their_FILE). - expand_
tilde - Expand a leading
~to$HOME; leave URIs (s3://…) and absolute paths untouched. - expanded
reposwith~in their paths expanded.- export
- The preferences as a TOML file that
importreads 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
overwriteit 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 forteamfrom this machine orserver. - local_
allowed_ signers COMINDLY_ALLOWED_SIGNERS→allowed_signers→ gitgpg.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→ gituser.name). - local_
signing_ key - This machine’s signing key:
COMINDLY_SIGNING_KEY→signing_key→ gituser.signingkeywhengpg.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
changesto the stored preferences.