Skip to content

Conversation

@akinomyoga
Copy link
Contributor

Moved from atuinsh/docs#106. Since the PRs in atuin/docs seem to have been invalidated by atuinsh/docs#112 and #3018, let me re-create the PR here.

This is the documentation update associated with the change introduced in atuinsh/atuin#2953. The current documentation about Bash's bindings is outdated.

Checks

  • I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle
  • I have checked that there are no existing pull requests for the same thing

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Jan 16, 2026

Greptile Summary

Updates Bash keybinding documentation to reflect the new atuin-bind utility introduced in version 18.10.0, replacing the outdated direct binding of __atuin_history.

  • Documents the new atuin-bind function with clear syntax and special command table
  • Moves old __atuin_history method to legacy section for backwards compatibility
  • Clarifies version requirements for bash < 4 compatibility (no longer restricted in >= 18.10.0)
  • Syntax issues from previous review have been addressed

Important Files Changed

Filename Overview
docs/docs/configuration/key-binding.md Documents new atuin-bind utility for Bash keybindings, replaces outdated __atuin_history documentation
docs/docs/guide/installation.md Updates version requirement note for bash < 4 compatibility

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 files reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

@akinomyoga akinomyoga force-pushed the docs-bash-atuin-bind branch from e01b9a4 to f7aa7a8 Compare January 16, 2026 16:18
@akinomyoga
Copy link
Contributor Author

@greptile-apps[bot] Could you check again?

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Jan 16, 2026

Greptile found no issues!

From now on, if a review finishes and we haven't found any issues, we will not post anything, but you can confirm that we reviewed your changes in the status check section.

This feature can be toggled off in your Code Review Settings by deselecting "Create a status check for each PR".

@akinomyoga akinomyoga force-pushed the docs-bash-atuin-bind branch from f7aa7a8 to 6192143 Compare January 16, 2026 17:06
@BinaryMuse
Copy link
Member

@ellie I'm not super familiar with this, would you mind taking a look at the merge conflict

@akinomyoga akinomyoga force-pushed the docs-bash-atuin-bind branch from 6192143 to 4946528 Compare January 16, 2026 20:38
@akinomyoga
Copy link
Contributor Author

The conflict was introduced by the merge of PR #3077, and there was no conflict when I submitted this PR four hours ago. I resolved the conflict and rebased it now.

@akinomyoga akinomyoga force-pushed the docs-bash-atuin-bind branch from 4946528 to 2fffd6a Compare January 16, 2026 20:47
@akinomyoga akinomyoga force-pushed the docs-bash-atuin-bind branch from 2fffd6a to 86e4b1d Compare January 16, 2026 20:53
@BinaryMuse
Copy link
Member

Awesome, thanks for rebasing - this looks good!

@BinaryMuse BinaryMuse merged commit 8955980 into atuinsh:main Jan 16, 2026
22 checks passed
@akinomyoga akinomyoga deleted the docs-bash-atuin-bind branch January 19, 2026 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants