diff options
| author | Michelle Tilley <michelle@michelletilley.net> | 2026-03-12 14:52:15 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-03-12 14:52:15 -0700 |
| commit | f7431afe2f0b424b6dcd0a76138607857563e008 (patch) | |
| tree | 2557c66400371ba2d353fbf847406c4028c3aafa /docs | |
| parent | chore: update changelog (diff) | |
| download | atuin-f7431afe2f0b424b6dcd0a76138607857563e008.zip | |
feat: Add `atuin setup` (#3257)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/ai/settings.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/docs/ai/settings.md b/docs/docs/ai/settings.md index 0a1f5b45..be27261f 100644 --- a/docs/docs/ai/settings.md +++ b/docs/docs/ai/settings.md @@ -2,6 +2,12 @@ All the settings that control the behavior of [Atuin AI](./introduction.md) are specified in an `[ai]` section in your `config.toml`. See [the configuration documentation](../../configuration/config/) for more detailed information about Atuin's configuration system. +### enabled + +Default: `false` + +Whether or not the AI feature are enabled. When set to `false`, the question mark keybinding will output a message with instructions to run `atuin setup` to enable the feature. + ### send_cwd Default: `false` @@ -19,10 +25,10 @@ send_cwd = true Default: `null` -The address of the Atuin AI endpoint. Used for AI features like command generation. Only necessary for custom AI endpoints. +The address of the Atuin AI endpoint. Used for AI features like command generation. Most users will not need this setting; it is only necessary for custom AI endpoints. ### api_token Default: `null` -The API token for the Atuin AI endpoint. Used for AI features like command generation. Only necessary for custom AI endpoints. +The API token for the Atuin AI endpoint. Used for AI features like command generation. Most users will not need this setting; it is only necessary for custom AI endpoints. |