mirror of
https://github.com/atuinsh/atuin.git
synced 2026-10-09 20:49:10 +02:00
311 lines
14 KiB
YAML
311 lines
14 KiB
YAML
site_name: Atuin Docs
|
|
site_url: https://docs.atuin.sh/
|
|
|
|
repo_name: atuinsh/atuin
|
|
repo_url: https://github.com/atuinsh/atuin
|
|
edit_uri: edit/main/docs/docs/
|
|
|
|
theme:
|
|
name: material
|
|
custom_dir: overrides
|
|
logo: assets/atuin-turtle.svg
|
|
favicon: assets/atuin-turtle.png
|
|
icon:
|
|
repo: octicons/mark-github-16
|
|
edit: octicons/pencil-16
|
|
view: octicons/eye-16
|
|
previous: octicons/arrow-left-16
|
|
next: octicons/arrow-right-16
|
|
top: octicons/arrow-up-16
|
|
menu: octicons/three-bars-16
|
|
close: octicons/x-16
|
|
search: octicons/search-16
|
|
share: octicons/link-16
|
|
alternate: octicons/moon-16
|
|
annotation: octicons/plus-circle-16
|
|
font:
|
|
text: DM Sans
|
|
code: Space Mono
|
|
palette:
|
|
- scheme: slate
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: octicons/sun-16
|
|
name: Switch to light mode
|
|
- scheme: default
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: octicons/moon-16
|
|
name: Switch to dark mode
|
|
features:
|
|
- navigation.instant # SPA-style page loads
|
|
- navigation.instant.prefetch # start fetching on link hover
|
|
- navigation.instant.progress # progress bar if a load is slow
|
|
- navigation.tracking # URL follows the anchor you are reading
|
|
- navigation.path # breadcrumbs above the page title
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top # back-to-top button
|
|
- toc.follow # right-hand ToC scrolls to keep up
|
|
- search.suggest
|
|
- search.highlight
|
|
- search.share # share buttons
|
|
- content.tabs.link # selecting a tab selects it everywhere
|
|
- content.code.copy # copy affordance on terminal
|
|
- content.action.edit # edit the page easily
|
|
- content.action.view # view the raw md
|
|
- content.tooltips # improved tooltips for abbreviations
|
|
|
|
plugins:
|
|
- search
|
|
- privacy # Download external assets at compile time for user privacy
|
|
- git-revision-date-localized:
|
|
enable_creation_date: true
|
|
- git-committers:
|
|
repository: atuinsh/atuin
|
|
branch: main
|
|
docs_path: docs/docs/
|
|
enabled: !ENV [MKDOCS_GIT_COMMITTERS_ENABLED, false]
|
|
token: !ENV [MKDOCS_GIT_COMMITTERS_APIKEY, ""]
|
|
cache_dir: .cache/plugin/git-committers/
|
|
exclude_committers:
|
|
- web-flow # gh web-editor
|
|
- claude
|
|
- greptile-apps[bot]
|
|
- dependabot[bot]
|
|
- github-actions[bot]
|
|
- redirects:
|
|
redirect_maps:
|
|
"cli/ai/command-output.md": "ai/command-output.md"
|
|
"cli/ai/introduction.md": "ai/introduction.md"
|
|
"cli/ai/mcp.md": "ai/mcp.md"
|
|
"cli/ai/self-hosting.md": "ai/self-hosting.md"
|
|
"cli/ai/settings.md": "ai/settings.md"
|
|
"cli/ai/skills.md": "ai/skills.md"
|
|
"cli/ai/slash-commands.md": "ai/slash-commands.md"
|
|
"cli/ai/tools-permissions.md": "ai/tools-permissions.md"
|
|
"cli/ai/user-context.md": "ai/user-context.md"
|
|
"cli/configuration/advanced-key-binding.md": "configuration/advanced-key-binding.md"
|
|
"cli/configuration/config.md": "configuration/config.md"
|
|
"cli/configuration/key-binding.md": "configuration/key-binding.md"
|
|
"cli/faq.md": "faq.md"
|
|
"cli/guide/advanced-usage.md": "guide/advanced-usage.md"
|
|
"cli/guide/agent-hooks.md": "guide/agent-hooks.md"
|
|
"cli/guide/basic-usage.md": "guide/basic-usage.md"
|
|
"cli/guide/delete-history.md": "guide/delete-history.md"
|
|
"cli/guide/dotfiles.md": "guide/dotfiles.md"
|
|
"cli/guide/getting-started.md": "guide/getting-started.md"
|
|
"cli/guide/import.md": "guide/import.md"
|
|
"cli/guide/installation.md": "guide/installation.md"
|
|
"cli/guide/shell-integration.md": "guide/shell-integration.md"
|
|
"cli/guide/sync.md": "guide/sync.md"
|
|
"cli/guide/theming.md": "guide/theming.md"
|
|
"cli/index.md": "index.md"
|
|
"cli/integrations.md": "integrations.md"
|
|
"cli/known-issues.md": "known-issues.md"
|
|
"cli/reference/config.md": "reference/config.md"
|
|
"cli/reference/daemon.md": "reference/daemon.md"
|
|
"cli/reference/doctor.md": "reference/doctor.md"
|
|
"cli/reference/gen-completions.md": "reference/gen-completions.md"
|
|
"cli/reference/hex.md": "reference/hex.md"
|
|
"cli/reference/import.md": "reference/import.md"
|
|
"cli/reference/info.md": "reference/info.md"
|
|
"cli/reference/list.md": "reference/list.md"
|
|
"cli/reference/prune.md": "reference/prune.md"
|
|
"cli/reference/pty-proxy.md": "reference/pty-proxy.md"
|
|
"cli/reference/search.md": "reference/search.md"
|
|
"cli/reference/stats.md": "reference/stats.md"
|
|
"cli/reference/sync.md": "reference/sync.md"
|
|
"cli/self-hosting/docker.md": "self-hosting/docker.md"
|
|
"cli/self-hosting/kubernetes.md": "self-hosting/kubernetes.md"
|
|
"cli/self-hosting/server-setup.md": "self-hosting/server-setup.md"
|
|
"cli/self-hosting/systemd.md": "self-hosting/systemd.md"
|
|
"cli/self-hosting/usage.md": "self-hosting/usage.md"
|
|
"cli/uninstall.md": "uninstall.md"
|
|
- llmstxt:
|
|
base_url: https://docs.atuin.sh
|
|
full_output: llms-full.txt
|
|
markdown_description: |
|
|
Atuin replaces your shell's built-in history with a SQLite database, adding context
|
|
(cwd, exit code, duration, hostname) and optionally syncing across machines with
|
|
end-to-end encryption. These docs cover the CLI tool - installation, configuration,
|
|
usage, self-hosting, and AI features.
|
|
sections:
|
|
Overview:
|
|
- index.md: Getting started with Atuin - quickstart, supported shells, and links.
|
|
- support.md: Support tiers and the platform/shell/feature matrix - which shells, OSes, terminals, and AI agents are supported and how well.
|
|
Guide:
|
|
- guide/getting-started.md: First steps - install, import history, and start using Atuin.
|
|
- guide/installation.md: Install via script, Homebrew, WinGet, Cargo, Nix, or from source.
|
|
- guide/sync.md: Register an account and set up end-to-end encrypted history sync.
|
|
- guide/import.md: Import existing shell history from bash, zsh, fish, and others.
|
|
- guide/basic-usage.md: What Atuin records, how to use the TUI, and common config tweaks.
|
|
- guide/advanced-usage.md: Filter modes (global, host, session, directory, workspace) and search modes (fuzzy, full-text, skim).
|
|
- guide/shell-integration.md: How shell hooks work, environment variables, and embedded terminals.
|
|
- guide/agent-hooks.md: Capture commands from AI coding agents (Claude Code, Codex, pi) and filter by author.
|
|
- guide/excluding-commands.md: Keep commands out of history with ignorespace, history_filter, and cwd_filter.
|
|
- guide/delete-history.md: Delete single entries, bulk delete by query, remove duplicates, or wipe everything.
|
|
- guide/dotfiles.md: Sync shell aliases and environment variables across machines.
|
|
- guide/theming.md: Customize the TUI with color themes.
|
|
Configuration:
|
|
- configuration/config.md: Complete reference for ~/.config/atuin/config.toml - all settings with defaults and examples.
|
|
- configuration/key-binding.md: Custom up-arrow filter mode, disable up-arrow or ctrl-r, vim mode.
|
|
- configuration/advanced-key-binding.md: Full keymap customization with emacs, vim-normal, vim-insert, and inspector modes.
|
|
Reference:
|
|
- reference/account.md: The `atuin account` command - register, login, change password, delete, and link to Hub.
|
|
- reference/config.md: The `atuin config` command - get, set, list, and resolve configuration values.
|
|
- reference/daemon.md: Background daemon for faster writes, auto-sync, and in-memory fuzzy search.
|
|
- reference/doctor.md: Diagnose common problems and dump system info for bug reports.
|
|
- reference/gen-completions.md: Generate shell completions for bash, fish, zsh, nushell, powershell, elvish.
|
|
- reference/init.md: The `atuin init` command - shell plugin setup, key binding flags, and env vars.
|
|
- reference/hex.md: The old name for `atuin pty-proxy`
|
|
- reference/pty-proxy.md: Experimental PTY proxy with popup rendering over existing terminal output.
|
|
- reference/import.md: Import history from bash, fish, zsh, replxx, mcfly, resh, and xonsh.
|
|
- reference/info.md: Show config file paths, env vars, and version info.
|
|
- reference/list.md: List history entries with formatting, filtering by cwd/session, and custom output templates.
|
|
- reference/prune.md: Delete entries matching history_filter config (useful after updating filters).
|
|
- reference/search.md: Search history with wildcards, filters (cwd, exit code, before/after), and delete mode.
|
|
- reference/stats.md: Compute stats for a time period - most used command, command count, unique commands.
|
|
- reference/store.md: The `atuin store` command - inspect, verify, rekey, rebuild, and repair the record store.
|
|
- reference/sync.md: Sync commands - register, login, manual sync, and account management.
|
|
Self Hosting:
|
|
- self-hosting/server-setup.md: Run your own Atuin sync server with PostgreSQL or SQLite.
|
|
- self-hosting/usage.md: Configure the client to use a self-hosted server.
|
|
- self-hosting/docker.md: Deploy with Docker or Docker Compose.
|
|
- self-hosting/kubernetes.md: Full Kubernetes deployment with Postgres, secrets, and ingress.
|
|
- self-hosting/systemd.md: Systemd service unit with hardening options.
|
|
AI:
|
|
- ai/introduction.md: Atuin AI - command generation and lookup via LLM from your terminal.
|
|
- ai/settings.md: AI configuration in config.toml - enabled, endpoint, session timeout.
|
|
- ai/slash-commands.md: Slash commands available in Atuin AI.
|
|
- ai/user-context.md: Send additional context to the LLM via TERMINAL.md files and dynamic shell substitution.
|
|
- ai/skills.md: Reusable instruction sets (skills) for Atuin AI - playbooks, conventions, workflows.
|
|
- ai/tools-permissions.md: Tools the AI can use (shell, filesystem) and permission files to control access.
|
|
- ai/command-output.md: Let Atuin AI read command outputs - capture via pty-proxy and the daemon.
|
|
- ai/mcp.md: Built-in MCP server exposing history search and command output to Claude Code, Cursor, and other AI tools.
|
|
- ai/self-hosting.md: Self-hosting the Atuin AI backend.
|
|
Misc:
|
|
- known-issues.md: Known issues with ZFS and network filesystems.
|
|
- integrations.md: Integrations with zsh-autosuggestions, zsh-vi-mode, ble.sh, and mcfly.
|
|
- faq.md: Frequently asked questions - IDE terminals, history filtering, up-arrow, uninstalling.
|
|
- uninstall.md: How to uninstall Atuin and remove all data.
|
|
- minify:
|
|
minify_html: true
|
|
minify_js: true
|
|
minify_css: true
|
|
htmlmin_opts:
|
|
remove_comments: true
|
|
|
|
not_in_nav: |
|
|
reference/hex.md
|
|
|
|
validation:
|
|
omitted_files: warn
|
|
absolute_links: warn
|
|
unrecognized_links: warn
|
|
anchors: warn
|
|
|
|
markdown_extensions:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- admonition
|
|
- pymdownx.details
|
|
- abbr
|
|
- pymdownx.snippets:
|
|
auto_append:
|
|
- includes/abbreviations.md
|
|
- attr_list
|
|
- md_in_html
|
|
- tables
|
|
- pymdownx.keys
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
|
|
extra_css:
|
|
- stylesheets/atuin.css
|
|
|
|
extra:
|
|
version:
|
|
provider: mike
|
|
default: latest
|
|
alias: true
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/atuinsh/atuin
|
|
name: Atuin on GitHub
|
|
- icon: fontawesome/brands/discord
|
|
link: https://discord.gg/jR3tfchVvW
|
|
name: Atuin on Discord
|
|
- icon: fontawesome/brands/x-twitter
|
|
link: https://x.com/atuinsh
|
|
name: Atuin on X
|
|
- icon: fontawesome/brands/mastodon
|
|
link: https://mastodon.online/@atuin@hachyderm.io
|
|
name: Atuin on Mastodon
|
|
- icon: fontawesome/brands/bluesky
|
|
link: https://bsky.app/profile/atuin.sh
|
|
name: Atuin on Bluesky
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Guide:
|
|
- Getting Started: guide/getting-started.md
|
|
- Installation: guide/installation.md
|
|
- Setting up sync: guide/sync.md
|
|
- Import existing history: guide/import.md
|
|
- Basic usage: guide/basic-usage.md
|
|
- Advanced usage: guide/advanced-usage.md
|
|
- Shell Integration: guide/shell-integration.md
|
|
- AI Agent Hooks: guide/agent-hooks.md
|
|
- Excluding commands: guide/excluding-commands.md
|
|
- Deleting history: guide/delete-history.md
|
|
- Syncing dotfiles: guide/dotfiles.md
|
|
- Theming: guide/theming.md
|
|
- Supported platforms: support.md
|
|
- Configuration:
|
|
- Config: configuration/config.md
|
|
- Key Binding: configuration/key-binding.md
|
|
- Advanced Key Binding: configuration/advanced-key-binding.md
|
|
- Reference:
|
|
- account: reference/account.md
|
|
- config: reference/config.md
|
|
- daemon: reference/daemon.md
|
|
- doctor: reference/doctor.md
|
|
- gen-completions: reference/gen-completions.md
|
|
- init: reference/init.md
|
|
- pty-proxy: reference/pty-proxy.md
|
|
- import: reference/import.md
|
|
- info: reference/info.md
|
|
- history list: reference/list.md
|
|
- history prune: reference/prune.md
|
|
- search: reference/search.md
|
|
- stats: reference/stats.md
|
|
- store: reference/store.md
|
|
- sync: reference/sync.md
|
|
- Self Hosting:
|
|
- Server Setup: self-hosting/server-setup.md
|
|
- Usage: self-hosting/usage.md
|
|
- Docker: self-hosting/docker.md
|
|
- Kubernetes: self-hosting/kubernetes.md
|
|
- Systemd: self-hosting/systemd.md
|
|
- AI:
|
|
- Introduction: ai/introduction.md
|
|
- Settings: ai/settings.md
|
|
- "Slash Commands": ai/slash-commands.md
|
|
- "User-Defined Context": ai/user-context.md
|
|
- Skills: ai/skills.md
|
|
- "Tools & Permissions": ai/tools-permissions.md
|
|
- "Reading Command Output": ai/command-output.md
|
|
- "MCP Server": ai/mcp.md
|
|
- "Self Hosting & Local Models": ai/self-hosting.md
|
|
- Known Issues: known-issues.md
|
|
- Integrations: integrations.md
|
|
- FAQ: faq.md
|
|
- Uninstall: uninstall.md
|