Skip to main content

Module config

Module config 

Source
Expand description

Where qcli keeps its settings: cli.conf in the Quvyta ecosystem’s folder, beside the other Quvyta apps.

~/.config/quvyta/
    quvyta.conf     the language, theme and icons every Quvyta app shares
    cli.conf        qcli's settings: the provider it talks to

The provider is four keys: the address, the model, the file the key is in and the header the key goes in. The key itself is never in this file, which people copy between machines and paste into reports; only the path of the file that holds it.

As a program of a QCode profile, qcli is told its provider by QCode instead, in two environment variables: the address of QCode’s relay inside the container and the model the profile chose. The relay adds the key outside the container, so on that road qcli reads no key and sends none, and the provider it was told is never written into this file.

Structs§

Provider
The provider as the settings describe it. Every field is what the person wrote, trimmed.
UpdateFolders
Where the ecosystem’s update notice reads its switch and remembers when it last asked.

Enums§

Missing
Why the provider cannot be asked yet.
ProfileError
Why the provider a QCode profile describes cannot be used. qcli does not open then: a tab that went on with the settings file instead would talk to a provider the profile never chose.
Source
Where the provider was described.

Constants§

ADDRESS
The key of the address the Messages API lives under.
ADDRESS_VARIABLE
The variable a QCode profile names its relay’s address in.
APP
The application’s id in the ecosystem: its settings file is cli.conf.
DEFAULT_HEADER
The header most servers of the Messages shape read the key from.
KEY_FILE
The key of the path of the file the key is read from.
KEY_HEADER
The key of the header the key goes in.
MODEL
The key of the model asked for.
MODEL_VARIABLE
The variable a QCode profile names its model in.

Functions§

load
The settings from the ecosystem’s folder, checked and healed.
load_in
load from folder as the ecosystem’s folder, so a test never touches the person’s own settings.
on_this_machine
Whether address is an http:// or https:// address of this machine: localhost, 127.x or ::1. An address that names a user before its host is not, whatever the host: it is not what a relay is given, and it makes the host easy to misread.
schema
What qcli’s own keys may hold. Every value is text; an empty one is the same as none.
spoken
The languages qcli speaks, for choosing the machine’s one before the runtime is built.