Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Files and configuration

You rarely need to edit these by hand: aq writes them as you use it.

Config: ~/.config/aq/config.toml

SettingWhat it holdsChanged with
themethe theme's namet
modeseach project's modeM
hide_fileswhether review cards hide the file listf
show_keyswhether the keys row showsF3
read_wpmthe fast reader's speed↑ ↓ in the reader
tutorial_donewhether the tour has been finished or skippedthe tour
workspacessaved workspaces: a root folder and its reposO

XDG_CONFIG_HOME moves the folder.

Themes

aq has five themes built in: tokyo-night, catppuccin-mocha, gruvbox-dark, rose-pine-dawn and ghostty. t moves to the next one.

To add your own, put a .toml file in ~/.config/aq/themes/. A theme with a built-in's name replaces it. Every colour is required:

name = "mine"
bg = "#1a1b26"      # background
panel = "#16161e"   # boxes and panels
line = "#232433"    # the cursor line
fg = "#c0caf5"      # text
dim = "#565f89"     # quiet text
acc = "#7aa2f7"     # accents and headings
hi = "#e0af68"      # highlights
add = "#9ece6a"     # added lines
add_bg = "#20303b"
del = "#f7768e"     # deleted lines
del_bg = "#37222c"
sel = "#283457"     # selection
key = "#7dcfff"     # key names in hints
ok = "#9ece6a"      # done and allowed

An optional syntax names one of the code highlighting themes bundled with aq; without it, aq builds one from the theme's own colours. A file with an error is skipped, with a warning.

State: ~/.local/state/aq/state.json

Review rounds, unsent comments and quiz progress, so a restart loses nothing. XDG_STATE_HOME moves the folder.

Socket

The hooks reach aq over a Unix socket: $XDG_RUNTIME_DIR/aq.sock, or /tmp/aq-$UID/aq.sock. AQ_SOCKET overrides it. The socket's folder must be private to you; aq refuses to start if other users can open it.