Repository navigation
docs: fix ctrl_n_shortcuts default value - #4458
Merged
Merged
Conversation
Contributor
 [Low impact] This documentation correction is safe to merge. SummaryCorrects the documented
Reviews (1) · Last reviewed commit: "docs: fix ctrl_n_shortcuts default value" · Reviewed by Greptile |
2 tasks done
Member
|
These PRs appear vibe-coded. @markovejnovic has used Claude Code to review these PRs to manage the sheer volume of this author's PRs. Checked against what a fresh install actually gets, since a few defaults differ between |
Member
|
/merge |
Collaborator
|
Landed as c579406. GitHub shows this merged once it reaches main. |
<!-- 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 -->
## Summary
The `macOS Ctrl-n key shortcuts` section documents `Default: `true``, but the option
defaults to `false`. The section's own prose contradicts it: it tells the reader to
"set the `ctrl_n_shortcuts` option to `true` in your config file" to get the Ctrl
shortcuts, which would be a no-op if they were already the default.
## Change
One word in `docs/docs/configuration/config.md`:
```diff
### macOS Ctrl-n key shortcuts
-Default: `true`
+Default: `false`
```
## Evidence
* `crates/atuin-client/src/settings.rs:1567` — `.set_default("ctrl_n_shortcuts", false)?`
* `crates/atuin-client/config.toml:91` — the shipped template line is
`# ctrl_n_shortcuts = false`
* `docs/docs/configuration/config.md:533` — the body of the same section still reads
"set the `ctrl_n_shortcuts` option to `true`", and the example block at `:535-538`
is commented "Use Ctrl-0 .. Ctrl-9 instead of Alt-0 .. Alt-9 UI shortcuts", i.e. an
opt-in.
Nothing else in the repo assumes a `true` default, so the docs line is the stale part.
## 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
## Verification
Docs-only, single token change; `cargo fmt` / clippy / MSRV are unaffected. I did not
run the Buildkite `Vale`/`codespell` steps locally (no toolchain here), but the edit
only flips `true` to `false` inside an existing inline code span on a line whose
surrounding prose is untouched.
Duplicate check: `gh pr list --state open --search "ctrl_n_shortcuts"` returns no
results. The only open PR touching `docs/docs/configuration/config.md` with nearby
content is atuinsh#3771, and its hunks are at `@@ -73` and `@@ -798 / -810` (the `[keys]`
section) — verified with `gh pr diff 3771`; it never reaches the macOS Ctrl-n section
at 529-538.
atuin-bot
force-pushed
the
docs/ctrl-n-shortcuts-default
branch
from
October 19, 2026 19:24
4f2d29f to
c579406
Compare
atuin-bot
pushed a commit
to ump45nose/atuin
that referenced
this pull request
Oct 19, 2026
<!-- 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 -->
## Summary
`docs/docs/reference/list.md` lists 6 "Supported variables" for `atuin history list --format`,
but `--help` advertises 11 and the implementation accepts all of them. A reader who trusts the
docs page doesn't learn that `{author}`, `{intent}`, `{exit}`, `{session}` and `{uuid}` exist.
## Change
```diff
{command}, {directory}, {duration}, {user}, {host} and {time}
+{command}, {directory}, {duration}, {user}, {host}, {author}, {intent}, {exit},
+{time}, {session}, and {uuid}
```
No code changes.
## Evidence
The list mirrors `atuin --help` for this subcommand, from the i18n message
`crates/atuin/i18n/en-US/atuin.ftl:211`:
> `Available variables: {command}, {directory}, {duration}, {user}, {host}, {author}, {intent}, {exit}, {time}, {session}, and {uuid}`
and each of those keys is handled by the formatter in
`crates/atuin/src/command/client/history.rs:319-343` (`"command"`, `"directory"`, `"exit"`,
`"duration"`, `"time"`, `"host"`, `"author"`, `"intent"`, `"user"`, `"session"`, `"uuid"`);
anything else returns `FormatKeyError::UnknownKey` at `:344`.
I deliberately kept to the 11 names that `--help` advertises rather than also documenting
`"relativetime"`, which is implemented at `history.rs:334` but is not part of this
subcommand's help message — that is a separate question about the CLI text, not the docs page.
## Verification
Docs-only; no `.rs` touched, so `cargo fmt`, clippy and MSRV are unaffected. The Buildkite
`Vale` / `codespell` steps were not run locally (no toolchain in this environment); the text
stays inside the existing fenced `text` block and only wraps onto a second line so the list is
not one long line.
Duplicate check:
* `gh pr list --state open --search "list.md in:file"` → no results.
* `gh pr list --state open --search "history list format in:title"` → no results.
* The open PR that adds `--format json` (atuinsh#3466) changes `crates/atuin/src/command/client/history.rs`
only and does not touch this page.
* My own open PRs (atuinsh#4451, atuinsh#4452, atuinsh#4458, atuinsh#4459) touch other files.
## 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
atuin-bot
pushed a commit
that referenced
this pull request
Oct 22, 2026
### Bug Fixes - *(ai)* Import IntoStaticStr from strum_macros, not strum ([#4480](#4480)) - *(ai)* Improve detection of git repositories ([#4450](#4450)) - *(client)* Resolve relative config paths beside config.toml, not the cwd ([#4479](#4479)) - *(config)* Don't print errors twice ([#4501](#4501)) - *(daemon)* Fetch the server's capabilities until a fetch succeeds - *(daemon)* Spare a stale pidfile's PID when evicting ([#4512](#4512)) - *(daemon)* Handle daemons not spawned by atuin ([#4516](#4516)) - *(output)* Keep quoted words together in output search ([#4502](#4502)) - *(packfile)* Load only the records inside a manifest's range - *(pty-proxy)* Standalone init with `atuin pty-proxy init` ([#4449](#4449)) - *(pty-proxy)* Wait for input on a non-blocking inherited stdin ([#4486](#4486)) - *(pty-proxy)* Don't re-exec shells running commands from a string or file ([#4414](#4414)) - *(search)* Don't panic when copying with no results ([#4426](#4426)) - *(server)* Let `ATUIN_*` environment variables override server.toml ([#4456](#4456)) - *(update)* Accept ATUIN_GITHUB_TOKEN ([#4262](#4262)) - Remove duplicated word in the no-history stats message ([#4451](#4451)) - Error printing in `?` handler ([#4448](#4448)) - Normalize relative gitdir paths in worktree resolution ([#4506](#4506)) - Upgrade regressions found in release QA ([#4519](#4519)) ### Documentation - Fix ctrl_n_shortcuts default value ([#4458](#4458)) - List all history list --format variables ([#4460](#4460)) - Fix the --reverse default for history list ([#4472](#4472)) - Mention December default in wrapped --year help ([#4476](#4476)) ### Features - *(common)* AbsPath and AbsPathBuf, Path and PathBuf checked to be absolute ([#4481](#4481)) - *(common)* Find a process's cgroup under cgroup v1 and v2 ([#4513](#4513)) - *(daemon)* Run the daemon as a launchd agent on macOS ([#4517](#4517)) - *(pty-proxy)* Window title follows child process ([#4447](#4447)) - *(secrets)* Keep HashiCorp tokens out of history ([#4445](#4445)) ### Miscellaneous Tasks - Give mono its own nixfmt step and scope atuin's to atuin/ - Say a /merge's landed commit gets CI on main - Rebuild the apt .deb cache for Ubuntu 24.04 ([#4504](#4504)) - Remove the benchmarks ([#4511](#4511)) ### Performance - *(common)* Compile the vendor regexes once ([#4485](#4485)) - *(common)* Drop the tree watcher's file-id cache ([#4492](#4492)) - *(common)* Release a line reader's buffer at the end of the file ([#4494](#4494)) - *(common)* Keep no tree watcher entry for a rejected file ([#4493](#4493)) - *(daemon)* Warm up only a resumed session's unanswered calls ([#4490](#4490)) - *(packfile)* Compress packs in one shot ([#4484](#4484)) ### Refactor - *(daemon)* Managed daemon service with multiple backends ([#4488](#4488)) - *(daemon)* Move daemon startup into the service module ([#4503](#4503)) - *(daemon)* Keep where the daemon listens behind service::address ([#4514](#4514)) - *(daemon)* Take up the daemon's socket in SocketHolder, not Backend ([#4515](#4515)) - *(deps)* Bump clap_complete_nushell from 4.6.0 to 4.6.2 ([#4473](#4473)) - *(deps)* Bump clap_complete from 4.6.9 to 4.6.11 ([#4396](#4396)) - *(deps)* Bump ratatui from 0.30.0 to 0.30.2 ([#4474](#4474)) - *(deps)* Bump certifi from 2025.11.12 to 2026.10.19 in /docs in the uv group across 1 directory ([#4500](#4500)) - *(pty-proxy)* Run on tokio with the parser on its own runtime ([#4482](#4482)) - *(pty-proxy)* Forward captures to the daemon on the proxy's runtime ([#4487](#4487)) - *(pty-proxy)* Rename the screen's parser to Emulator ([#4510](#4510)) - *(pty-proxy)* Migrate output parsing to vte ([#4518](#4518)) ### Testing - *(daemon)* Run the output index tests under rstest ([#4496](#4496))
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
macOS Ctrl-n key shortcutssection documentsDefault:true``, but the optiondefaults to
false. The section's own prose contradicts it: it tells the reader to"set the `ctrl_n_shortcuts` option to `true` in your config file" to get the Ctrl
shortcuts, which would be a no-op if they were already the default.
Change
One word in
docs/docs/configuration/config.md:Evidence
crates/atuin-client/src/settings.rs:1567—.set_default("ctrl_n_shortcuts", false)?crates/atuin-client/config.toml:91— the shipped template line is# ctrl_n_shortcuts = falsedocs/docs/configuration/config.md:533— the body of the same section still reads"set the
ctrl_n_shortcutsoption totrue", and the example block at:535-538is commented "Use Ctrl-0 .. Ctrl-9 instead of Alt-0 .. Alt-9 UI shortcuts", i.e. an
opt-in.
Nothing else in the repo assumes a
truedefault, so the docs line is the stale part.Checks
Verification
Docs-only, single token change;
cargo fmt/ clippy / MSRV are unaffected. I did notrun the Buildkite
Vale/codespellsteps locally (no toolchain here), but the editonly flips
truetofalseinside an existing inline code span on a line whosesurrounding prose is untouched.
Duplicate check:
gh pr list --state open --search "ctrl_n_shortcuts"returns noresults. The only open PR touching
docs/docs/configuration/config.mdwith nearbycontent is #3771, and its hunks are at
@@ -73and@@ -798 / -810(the[keys]section) — verified with
gh pr diff 3771; it never reaches the macOS Ctrl-n sectionat 529-538.