Configuration
This section will guide you through the basic configuration options available in Lucy.
info
Lucy is designed to work out-of-the-box with sensible defaults. However, you can customize its behavior through various configuration options.
App Settings
After installing Lucy, and running any command (e.g., lucy --version), a configuration file named appsettings.json will be created in your user profile directory. This file contains various settings that you can modify to customize Lucy's behavior.
| Environment | Path |
|---|---|
| Windows | %USERPROFILE%\AppData\Local\Spokesoft\Lucy\appsettings.json |
| macOS | $HOME/Library/Application Support/Spokesoft/Lucy/appsettings.json |
| Linux | $HOME/.local/share/Spokesoft/Lucy/appsettings.json |
Environment Variables
Each configuration option in the appsettings.json file can also be set using environment variables. The environment variable names are derived from the JSON structure by replacing dots (.) with underscores (_) and prefixing them with Lucy_.
| App Settings | Environment Variable | Description |
|---|---|---|
| Database.DataSource | Lucy_Database_DataSource | Path to the database file. Default: user profile directory |
| Database.DefaultFileName | Lucy_Database_DefaultFileName | Default name of the database file. Default: lucy.db |
| Database.DefaultTimeout | Lucy_Database_DefaultTimeout | Default timeout for database operations in seconds. Default: 30 |
| Logging.Database.DataSource | Lucy_Logging_Database_DataSource | Path to the logging database file. Default: user profile directory |
| Logging.Database.DefaultFileName | Lucy_Logging_Database_DefaultFileName | Default name of the logging database file. Default: logs.db |
| Logging.Database.DefaultTimeout | Lucy_Logging_Database_DefaultTimeout | Default timeout for logging database operations in seconds. Default: 30 |