Skip to content

Core concepts / 6 minute guide

Settings

Configure an Environment with named groups of entries and references to stored secrets.

Last verified 2026-10-19

A Setting is a named group of configuration entries

Each Environment owns a collection of Settings. A Setting has a name, an optional description, and entries consisting of a key, a value, and a value type. For example, a group for a model integration might hold its model choice and a reference to an API credential.

Setting names are unique within the Environment. Entry keys must also be unique across all Settings in that Environment. Putting the same key in two groups does not create an override order; Elyxis rejects the conflict.

All Settings contribute configuration

You select an Environment. Its Settings contribute their entries together; you do not activate one Setting as a separate profile. Group names help you organize and manage configuration.

Environment: Sandbox
  Setting: Model configuration
    model choice
    API credential reference
  Setting: Catalog configuration
    database endpoint
    collection name

The names above illustrate the grouping. Use the actual entry keys and values required by the selected integration, rather than copying these labels as configuration keys.

Literal values and secret references

Value typeUse it forHow to supply it
LITERALNon-secret configuration such as a model name or endpoint.Enter the value requested by the setup question.
KEYSTORE_ALIASA reference to a secret in an Environment Keystore.Choose /store when the CLI asks for a Setting entry value.

In the guided value prompt, /store lets you select a store and then a key. For an Elyxis store, the CLI lists stored key aliases. For a managed store, it asks for the provider's secret key alias. See Keystores.

Typing text that looks like a reference into an ordinary value answer is not the same as selecting a stored value. Use /store to make the source explicit. If that option is unavailable, ask your administrator how the secret should be bound.

Set up an integration

Name the service you want to configure. Elyxis uses the Environment already selected in your session; you do not need to repeat its name:

Help me configure OpenAI settings.

Elyxis can inspect the available integration requirements and guide you through the missing inputs. A supported Plugin or service binding must be available. Review the setting name, Environment, and proposed changes before approving.

For an organizational group with no provider setup, you can instead ask:

Create an empty setting named Ticket defaults.

Creating an empty group does not configure an integration.

Update an existing entry

Name the Setting and the change you want. Ask to update the particular entry rather than replace the complete list:

Show the settings, then help me change the model entry in Model configuration.

During a guided entry update, an empty answer or /skip keeps the current value. Use /clear only when the prompt offers it and you intend to clear the value. Check the confirmed resource and remaining entry keys in the result.

Understand Keystores and secret references