%%SUBTITLE%%
A config artifact is a named settings file of this machine: data.json of config::<name>,
in the local repository unless it was made elsewhere. Every command below works the same in cmd,
PowerShell and bash; the details of a key give the line for that key.
cx config set <name> --meta.<key>=<value> | sets a key (the config is made when it is missing); several --meta. at once are fine |
--meta.a.b=v | a nested key: each dot is one level (test_session.max_keep_mib) - a key whose own name holds a dot cannot be set so |
--meta.k,=a,b | a list (the comma after the key); a value with commas of its own (a cRef) is one text, with ; between its items when the reader allows it |
cx config unset <name> --meta.<key> | removes a key - its default applies again |
cx config show <name> | lists what is set, as --meta. lines to copy, and where its data.json is |
cx config read <name> | the same for a program: it never makes the config (get does) |
| A server | reads some configs once, at its start (the cserver: cx app run cserver): restart it after a change; a page reads its keys on every request |
| A secret | (a password, a token, a key) is never shown here; set it on the machine itself - a value typed on the command line stays in the shell's history (cx utils hash_password keeps a password's digest instead) |
| Your own keys | an artifact that reads a config declares its keys in its _desc.yaml (configs: → the config → keys: → each key with desc, type, default, example, secret): they show here with what they do |
word "a phrase" | in the key, its config, what it does, its default, its value here or the artifacts that read it |
-word | in none of them |
config:task key:browse | the keys of one config artifact (cfg: too; * and ? are patterns) / whose name holds it |
art:run-ai art:task:: | read, declared or shown by an artifact whose name (category::alias) holds it - or pick it in the map on the left |
repo:cmeta-aops cat:tool | read, declared or shown by an artifact of that repository / category |
is:set is:unset | set on this machine / not set (its default applies) |
is:unread | set here, read by no plugged artifact |
is:declared is:code is:docs | known from a configs block of a _desc.yaml / the code that reads it / a cx config set line or a table of a README |
is:secret is:dynamic is:undocumented | a key whose value is never shown / a key with parts the code names at run time (<harness>) / a key nothing describes |
| Letters | D declared, C read by code, R shown in a README or the docs |