diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/ai/introduction.md | 2 | ||||
| -rw-r--r-- | docs/docs/ai/settings.md | 12 | ||||
| -rw-r--r-- | docs/docs/configuration/config.md | 6 |
3 files changed, 16 insertions, 4 deletions
diff --git a/docs/docs/ai/introduction.md b/docs/docs/ai/introduction.md index 39c45eec..0c235428 100644 --- a/docs/docs/ai/introduction.md +++ b/docs/docs/ai/introduction.md @@ -1,6 +1,6 @@ # Atuin AI -Atuin AI is a separate binary that enables command generation and other information lookup via an LLM directly from your terminal. It is completely opt-in, and will not change the behavior of Atuin at all if you choose not to use it. +Atuin AI is a subcommand that enables shell command generation and other information lookup via an LLM directly from your terminal. It is completely opt-in, and will not change the behavior of Atuin at all if you choose not to use it. Atuin AI requires an account on [Atuin Hub](https://hub.atuin.sh/), and you'll be prompted to login upon first use of the binary. diff --git a/docs/docs/ai/settings.md b/docs/docs/ai/settings.md index eb868f91..0a1f5b45 100644 --- a/docs/docs/ai/settings.md +++ b/docs/docs/ai/settings.md @@ -14,3 +14,15 @@ Whether or not to include your current working directory in the context sent to [ai] send_cwd = true ``` + +### endpoint + +Default: `null` + +The address of the Atuin AI endpoint. Used for AI features like command generation. 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. diff --git a/docs/docs/configuration/config.md b/docs/docs/configuration/config.md index 693a528d..6e2595ae 100644 --- a/docs/docs/configuration/config.md +++ b/docs/docs/configuration/config.md @@ -800,7 +800,7 @@ How many days of log files to keep (per file type). Files older than this will b A sub-object with specific options for AI logging: * `enabled` - whether to output AI logs; defaults to `logs.enabled` -* `file` - the filename to use for the AI logs; defaults to `"ai.log"`. Can be absolute, or relative to `logs.dir`. +* `file` - the filename to use for the AI logs; defaults to `"ai.log"`. Always relative to `logs.dir`. * `level` - override the log level for the AI logs; defaults to `logs.level` * `retention` - how many days to store AI logs; defaults to `logs.retention` @@ -809,7 +809,7 @@ A sub-object with specific options for AI logging: A sub-object with specific options for daemon logging: * `enabled` - whether to output daemon logs; defaults to `logs.enabled` -* `file` - the filename to use for the daemon logs; defaults to `"daemon.log"`. Can be absolute, or relative to `logs.dir`. +* `file` - the filename to use for the daemon logs; defaults to `"daemon.log"`. Always relative to `logs.dir`. * `level` - override the log level for the daemon logs; defaults to `logs.level` * `retention` - how many days to store daemon logs; defaults to `logs.retention` @@ -818,7 +818,7 @@ A sub-object with specific options for daemon logging: A sub-object with specific options for search logging: * `enabled` - whether to output search logs; defaults to `logs.enabled` -* `file` - the filename to use for the search logs; defaults to `"search.log"`. Can be absolute, or relative to `logs.dir`. +* `file` - the filename to use for the search logs; defaults to `"search.log"`. Always relative to `logs.dir`. * `level` - override the log level for the search logs; defaults to `logs.level` * `retention` - how many days to store search logs; defaults to `logs.retention` |