atuin
✨ Making your shell magical
File Explorer
Download Latest Version (.zip)- SKILL.md
- audit.toml
- config.toml
- SKILL.md
- codespell.yml
- installer.yml
- nix.yml
- rust.yml
- shellcheck.yml
- update-nix-deps.yml
- devcontainer-feature.json
- install.sh
- devcontainer-lock.json
- devcontainer.json
- Dockerfile
- entrypoint.sh
- action.yml
- action.yml
- action.yml
- action.yml
- action.yml
- support.yml
- bug.yaml
- beta-release.yml
- codespell.yml
- devcontainer.yaml
- docker.yaml
- docs-main.yml
- docs-release.yml
- installer.yml
- nix.yml
- release.yml
- rust.yml
- shellcheck.yml
- update-nix-deps.yml
- vale.yml
- dependabot.yml
- FUNDING.yml
- pull_request_template.md
- accept.txt
- atuin.ts
- atuin.ts
- atuin.ts
- atuin.ts
- change_password.rs
- delete.rs
- link.rs
- login.rs
- logout.rs
- register.rs
- alias.rs
- var.rs
- event.rs
- wire.rs
- bash.rs
- fish.rs
- nu.rs
- powershell.rs
- xonsh.rs
- zsh.rs
- daemon.rs
- db.rs
- actions.rs
- conditions.rs
- defaults.rs
- key.rs
- keymap.rs
- mod.rs
- cursor.rs
- engines.rs
- history_list.rs
- inspector.rs
- interactive.rs
- syntax.rs
- pull.rs
- purge.rs
- push.rs
- rebuild.rs
- rekey.rs
- verify.rs
- status.rs
- account.rs
- config.rs
- daemon.rs
- default_config.rs
- doctor.rs
- dotfiles.rs
- history.rs
- hook.rs
- import.rs
- info.rs
- init.rs
- internal.rs
- kv.rs
- lab.rs
- scripts.rs
- search.rs
- setup.rs
- stats.rs
- store.rs
- sync.rs
- update.rs
- wrapped.rs
- client.rs
- CONTRIBUTORS
- contributors.rs
- external.rs
- gen_completions.rs
- mod.rs
- disabled.rs
- enabled.rs
- mod.rs
- otel.rs
- include-guard.bash
- .gitattributes
- atuin.bash
- atuin.fish
- atuin.nu
- atuin.ps1
- atuin.xsh
- atuin.zsh
- main.rs
- print_error.rs
- shell.rs
- sync.rs
- bash-preexec
- build.rs
- Cargo.toml
- CHANGELOG.md
- LICENSE
- README.md
- 20260413000000_create_ai_sessions.sql
- 20260417000000_add_session_metadata.sql
- 20260707000000_create_ai_usage.sql
- inline.rs
- effects.rs
- events.rs
- mod.rs
- tests.rs
- tools.rs
- check.rs
- file.rs
- mod.rs
- resolver.rs
- rule.rs
- shell.rs
- walker.rs
- writer.rs
- frontmatter.rs
- mod.rs
- walker.rs
- descriptor.rs
- mod.rs
- help.md
- input.rs
- mod.rs
- trunc.rs
- turn.rs
- app.rs
- bridge.rs
- events.rs
- mod.rs
- persist.rs
- recall.rs
- select.rs
- slash.rs
- state.rs
- tips.rs
- tools_exec.rs
- interpolate.rs
- mod.rs
- walker.rs
- commands.rs
- context.rs
- context_window.rs
- diff.rs
- edit_permissions.rs
- event_serde.rs
- file_tracker.rs
- history_format.rs
- lib.rs
- mcp.rs
- models.rs
- session.rs
- shell.rs
- snapshots.rs
- store.rs
- stream.rs
- usage.rs
- Cargo.toml
- render-tests.sh
- replay-states.sh
- test-renders.json
- context.rs
- mod.rs
- encryption.rs
- mod.rs
- sqlite_store.rs
- benchmarks.rs
- history.rs
- history_store.rs
- ordering.rs
- 20260203030924_create_meta.sql
- 20210422143411_create_history.sql
- 20220505083406_create-events.sql
- 20220806155627_interactive_search_index.sql
- 20230315220114_drop-events.sql
- 20230319185725_deleted_at.sql
- 20260224000100_history_author_intent.sql
- 20260709214605_shell.sql
- 20260723000000_active_history_index.sql
- 20260723000001_filtered_history_indexes.sql
- 20260723000002_hostname_index.sql
- 20260723000003_drop_command_index.sql
- 20260818000000_history_author_kind.sql
- packer.txt
- 20230531212437_create-records.sql
- 20231127090831_create-store.sql
- 20260723000000_store_tag_index.sql
- builder.rs
- store.rs
- bash.rs
- fish.rs
- mod.rs
- nu.rs
- nu_histdb.rs
- powershell.rs
- replxx.rs
- resh.rs
- xonsh.rs
- xonsh_sqlite.rs
- zsh.rs
- zsh_histdb.rs
- mod.rs
- packer.rs
- record.rs
- builder.rs
- mod.rs
- packfile.rs
- mod.rs
- sqlite_store.rs
- daemon.rs
- dotfiles.rs
- kv.rs
- meta.rs
- scripts.rs
- shells.rs
- watcher.rs
- api_client.rs
- auth.rs
- database.rs
- distro.rs
- history.rs
- hub.rs
- lib.rs
- login.rs
- logout.rs
- logs.rs
- meta.rs
- ordering.rs
- plugin.rs
- register.rs
- secrets.rs
- settings.rs
- theme.rs
- xonsh-82eafbf5-9f43-489a-80d2-61c7dc6ef542.json
- xonsh-de16af90-9148-4461-8df3-5b5659c6420d.json
- xonsh-history.sqlite
- build.rs
- Cargo.toml
- config.toml
- ellipsis.txt
- ansi.txt
- time.txt
- mod.rs
- paseto_v4.rs
- mod.rs
- stream.rs
- unix.rs
- display_rich.rs
- mod.rs
- decode.rs
- encode.rs
- mod.rs
- align.rs
- ellipsis.rs
- escape_non_printable_posix_ext.rs
- non_nul_str.rs
- eager_future_cell.rs
- mod.rs
- capture.rs
- duration.rs
- offset_date_time.rs
- utc_offset.rs
- ansi.rs
- docs.rs
- filter.rs
- lib.rs
- logs.rs
- os.rs
- shell.rs
- slice.rs
- string.rs
- test_utils.rs
- time.rs
- url.rs
- utils.rs
- Cargo.toml
- control.proto
- history.proto
- search.proto
- semantic.proto
- history.rs
- mod.rs
- search.rs
- semantic.rs
- sync.rs
- mod.rs
- service.rs
- mod.rs
- index.rs
- mod.rs
- normalize.rs
- mod.rs
- client.rs
- daemon.rs
- events.rs
- lib.rs
- server.rs
- lifecycle.rs
- search.rs
- build.rs
- Cargo.toml
- all.rs
- axum.rs
- client.rs
- http.rs
- middleware.rs
- mod.rs
- server.rs
- cmd_origin.rs
- mod.rs
- tag.rs
- version.rs
- api.rs
- lib.rs
- Cargo.toml
- bash.rs
- fish.rs
- powershell.rs
- xonsh.rs
- zsh.rs
- alias.rs
- var.rs
- lib.rs
- shell.rs
- store.rs
- Cargo.toml
- smart_sort.rs
- lib.rs
- sort.rs
- stats.rs
- Cargo.toml
- 20250501160746_create_kv_db.down.sql
- 20250501160746_create_kv_db.up.sql
- entry.rs
- record.rs
- database.rs
- lib.rs
- store.rs
- Cargo.toml
- mod.rs
- screen.rs
- backpressure.rs
- crypto.rs
- error.rs
- lib.rs
- lifecycle.rs
- protocol.rs
- proxy_tap.rs
- query.rs
- render.rs
- source.rs
- subshell.rs
- transport.rs
- js-sealed-input.json
- seal-input.mjs
- Cargo.toml
- capture.rs
- debug.rs
- lib.rs
- osc133.rs
- protocol.rs
- pty_proxy.rs
- runtime.rs
- screen.rs
- fd_pressure.rs
- subscriber.rs
- Cargo.toml
- 20250326160051_create_scripts.down.sql
- 20250326160051_create_scripts.up.sql
- 20250402170430_unique_names.down.sql
- 20250402170430_unique_names.up.sql
- record.rs
- script.rs
- database.rs
- execution.rs
- lib.rs
- settings.rs
- store.rs
- Cargo.toml
- search.rs
- corpus.rs
- lib.rs
- Cargo.toml
- main.rs
- me.rs
- mod.rs
- record.rs
- store.rs
- health.rs
- mod.rs
- user.rs
- lib.rs
- metrics.rs
- router.rs
- settings.rs
- trace.rs
- mod.rs
- sync.rs
- users.rs
- Cargo.toml
- CHANGELOG.md
- server.toml
- lib.rs
- models.rs
- Cargo.toml
- 20210425153745_create_history.sql
- 20210425153757_create_users.sql
- 20210425153800_create_sessions.sql
- 20220419082412_add_count_trigger.sql
- 20220421073605_fix_count_trigger_delete.sql
- 20220421174016_larger-commands.sql
- 20220426172813_user-created-at.sql
- 20220505082442_create-events.sql
- 20220610074049_history-length.sql
- 20230315220537_drop-events.sql
- 20230315224203_create-deleted.sql
- 20230515221038_trigger-delete-only.sql
- 20230623070418_records.sql
- 20231202170508_create-store.sql
- 20231203124112_create-store-idx.sql
- 20240108124837_drop-some-defaults.sql
- 20240614104159_idx-cache.sql
- 20240621110731_user-verified.sql
- 20240702094825_idx_cache_index.sql
- 20260127000000_remove-email-verification.sql
- lib.rs
- wrappers.rs
- build.rs
- Cargo.toml
- 20231203124112_create-store.sql
- 20240108124830_create-history.sql
- 20240108124831_create-sessions.sql
- 20240621110730_create-users.sql
- 20240621110731_create-user-verification-token.sql
- 20240702094825_create-store-idx-cache.sql
- 20260127000000_remove-email-verification.sql
- lib.rs
- wrappers.rs
- build.rs
- Cargo.toml
- helpers.rs
- lib.rs
- db_story.rs
- Cargo.toml
- README.md
- basic-followup-questions.png
- basic-refine.png
- basic.png
- danger.png
- question.png
- tool_atuin_history.png
- tool_fs.png
- tool_shell.png
- command-output.md
- introduction.md
- mcp.md
- self-hosting.md
- settings.md
- skills.md
- slash-commands.md
- tools-permissions.md
- user-context.md
- atuin-turtle.png
- atuin-turtle.svg
- advanced-key-binding.md
- config.md
- key-binding.md
- advanced-usage.md
- agent-hooks.md
- basic-usage.md
- delete-history.md
- dotfiles.md
- excluding-commands.md
- getting-started.md
- import.md
- installation.md
- shell-integration.md
- sync.md
- theming.md
- account.md
- config.md
- daemon.md
- doctor.md
- gen-completions.md
- hex.md
- import.md
- info.md
- init.md
- list.md
- prune.md
- pty-proxy.md
- search.md
- stats.md
- store.md
- sync.md
- docker.md
- kubernetes.md
- server-setup.md
- systemd.md
- usage.md
- atuin.css
- faq.md
- index.md
- integrations.md
- known-issues.md
- support.md
- uninstall.md
- abbreviations.md
- main.html
- 404.html
- atuin-logo-horizontal.png
- CNAME
- common.py
- filter_dead_vers.py
- gen_legacy_stubs.py
- parse_version.py
- .gitignore
- main.py
- mkdocs.yml
- pyproject.toml
- uv.lock
- atuin.yaml
- namespaces.yaml
- secrets.yaml
- release.sh
- atuin-server.service
- atuin-server.sysusers
- publish-crates.yml
- rust.yml
- dependabot.yml
- compress.rs
- compression.rs
- dirs.rs
- error.rs
- lib.rs
- local.rs
- remote.rs
- source.rs
- spanned.rs
- logo.png
- README.md
- styles.css
- common.rs
- local_copy.rs
- local_load.rs
- local_new.rs
- local_remove.rs
- local_write.rs
- remote_copy.rs
- remote_load.rs
- remote_write.rs
- source.rs
- .gitignore
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- LICENSE-APACHE
- LICENSE-MIT
- README.md
- rust-toolchain.toml
- SECURITY.md
- bats.yaml
- bash-preexec.bats
- include-test.bats
- README.md
- bash-preexec.sh
- LICENSE.md
- README.md
- .repositories.json
- README.md
- vendor.sh
- .codespellrc
- .dockerignore
- .editorconfig
- .fossier.db
- .gitattributes
- .gitignore
- .mailmap
- .nvim.lua
- .rustfmt.toml
- .vale.ini
- AGENTS.md
- atuin.nix
- atuin.plugin.zsh
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- cliff.toml
- clippy.toml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- CONTRIBUTORS
- Cross.toml
- default.nix
- demo.gif
- deny.toml
- depot.json
- dist-workspace.toml
- Dockerfile
- flake.lock
- flake.nix
- fossier.toml
- install.sh
- LICENSE
- README.md
- rust-toolchain.toml
- SECURITY.md
- VOUCHED.td
# Installation Guide
1. Get the code
git clone https://github.com/atuinsh/atuin
Downloads the entire project code from GitHub to your computer.
cd atuin
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommendedcurl --proto '=https' --tlsv1.2 -LsSf https://setup.atuin.sh | sh
Downloads and runs the official install script in one line — this handles the full setup automatically.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t atuin .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 atuin
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation
Was this content helpful?
(0 ratings)