diff options
| author | Ellie Huxtable <ellie@atuin.sh> | 2026-02-25 19:10:58 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-02-25 19:10:58 -0800 |
| commit | 9fe7d10fcf73570767ba7b4eabaa95f65958821b (patch) | |
| tree | ed9705225db8e5bbe2f3c689ba5d1c9908b75eb1 /docs | |
| parent | feat: Generate commands or ask questions with `atuin ai` (#3199) (diff) | |
| download | atuin-9fe7d10fcf73570767ba7b4eabaa95f65958821b.zip | |
feat: Add history author/intent metadata and v1 record version (#3205)
<!-- Thank you for making a PR! Bug fixes are always welcome, but if
you're adding a new feature or changing an existing one, we'd really
appreciate if you open an issue, post on the forum, or drop in on
Discord -->
## Checks
- [x] I am happy for maintainers to push small adjustments to this PR,
to speed up the review cycle
- [x] I have checked that there are no existing pull requests for the
same thing
Adds `author` and `intent` to client history records and DB persistence,
including migration/backfill and CLI/daemon propagation.
Introduces V2 record-store history version `v1` while retaining read
compatibility for legacy `v0` records.
Adds `--author` and `--intent` flags to `atuin history start`, plus
`{author}` and `{intent}` format keys for listing/history output.
Updates shell-integration docs for `ATUIN_HISTORY_AUTHOR` and
`ATUIN_HISTORY_INTENT`, and updates related tests/fixtures.
Validated with `cargo test -p atuin-client --lib`, `cargo test -p
atuin-daemon --tests`, `cargo test -p atuin search::inspector`, and
`cargo fmt --check`.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/guide/shell-integration.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/docs/guide/shell-integration.md b/docs/docs/guide/shell-integration.md index 6881bf71..cc0d2530 100644 --- a/docs/docs/guide/shell-integration.md +++ b/docs/docs/guide/shell-integration.md @@ -26,8 +26,11 @@ When Atuin initializes, it sets several environment variables: | `ATUIN_SESSION` | Unique identifier for this shell session | | `ATUIN_SHLVL` | Tracks shell nesting level | | `ATUIN_HISTORY_ID` | Temporary ID for the currently executing command | +| `ATUIN_HISTORY_AUTHOR` | Optional command author identity (for example `ellie`, `claude`, `copilot`) | +| `ATUIN_HISTORY_INTENT` | Optional command intent/rationale text | These variables are used internally to track command execution and associate commands with sessions. +If `ATUIN_HISTORY_AUTHOR` is not set, Atuin defaults to the local shell username. ## Embedded Terminals and IDE Integrations |