diff options
Diffstat (limited to 'docs/mkdocs.yml')
| -rw-r--r-- | docs/mkdocs.yml | 169 |
1 files changed, 0 insertions, 169 deletions
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml deleted file mode 100644 index b0fb2491..00000000 --- a/docs/mkdocs.yml +++ /dev/null @@ -1,169 +0,0 @@ -site_name: Atuin CLI Docs -site_url: https://docs.atuin.sh/cli/ - -repo_name: atuinsh/atuin -repo_url: https://github.com/atuinsh/atuin -edit_uri: edit/main/docs/docs/ - -theme: - name: material - palette: - - scheme: default - primary: deep purple - accent: deep purple - toggle: - icon: material/brightness-7 - name: Switch to dark mode - - scheme: slate - primary: deep purple - accent: deep purple - toggle: - icon: material/brightness-4 - name: Switch to light mode - features: - - navigation.sections - - navigation.expand - - search.suggest - - search.highlight - - content.code.copy - - content.action.edit - - content.action.view - -# NOTE: to enable ToC and heading anchor links in local (non-multirepo) development, -# comment out the `multirepo` plugin and all its settings. -# Note that this changes the top-level directory when developing locally -# from `/cli/CLI/` to `/cli/. - -plugins: - - search - - multirepo: - imported_repo: true - url: https://github.com/atuinsh/docs - section_name: CLI - paths: ["mkdocs.yml", "docs/index.md", "docs/stylesheets/*"] - yml_file: mkdocs.yml - branch: mkt/docs-migration - - llmstxt: - base_url: https://docs.atuin.sh/cli - 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. - 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, embedded terminals, and excluding commands. - - guide/agent-hooks.md: Capture commands from AI coding agents (Claude Code, Codex, pi) and filter by author. - - 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/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/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/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/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. - 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. - - sync-v2.md: Upgrading from sync v1 to v2 - faster, more reliable, less bandwidth. - -markdown_extensions: - - pymdownx.highlight: - anchor_linenums: true - - pymdownx.superfences - - pymdownx.tabbed: - alternate_style: true - - admonition - - pymdownx.details - - 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 - -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 - - Deleting history: guide/delete-history.md - - Syncing dotfiles: guide/dotfiles.md - - Theming: guide/theming.md - - Configuration: - - Config: configuration/config.md - - Key Binding: configuration/key-binding.md - - Advanced Key Binding: configuration/advanced-key-binding.md - - Reference: - - config: reference/config.md - - daemon: reference/daemon.md - - doctor: reference/doctor.md - - gen-completions: reference/gen-completions.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 - - 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 - - "User-Defined Context": ai/user-context.md - - Skills: ai/skills.md - - "Tools & Permissions": ai/tools-permissions.md - - Known Issues: known-issues.md - - Integrations: integrations.md - - FAQ: faq.md - - Uninstall: uninstall.md - - Sync v2: sync-v2.md |