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

Options

Set any of these in your init.luau, e.g. require("@greed").option.set("motion-hints", true), or while the editor runs with :set motion-hints true.

OptionDefaultPluginWhat it does
agent-editor-contexttrueacpSend agents the file you’re in, the cursor, the selection and the other files on screen with each message
agent-eval"auto"agentHow Luau from agents runs: “auto” (sandboxed, a reviewer or you for more), “ask”, “allow” or “off”
agent-greed-toolstrueacpGive agents Greed’s own tools (buffers, diagnostics, syntax queries, proposals) through greed mcp
agent-sessions-kept50acpHow many sessions with Greed’s own agent are kept per repository to take up again; older ones are deleted
agent-tool-groups"plan"agentThe tool groups agents get from the start, besides those they switch on: names with spaces between, or “all”
agent-workspace-editstrueacpLet agents in a workspace of their own edit, move and delete files there without asking
assist-role"fast"assistThe model role assist’s commands ask; see :models
auto-reloadtruecoreLoad files changed on disk into their buffers, unless they have unsaved changes
auto-savefalsecoreSave files on their own a moment after their edits stop
auto-save-delay1000coreHow long after the last edit auto-save saves, in milliseconds
blocks-max-lines1000blocksThe most lines of output a block’s result keeps; the rest is cut
claude-command"claude"agentHow the Claude pane starts Claude Code, e.g. “claude –continue”
completion-delay150lspMilliseconds of no typing before a completion menu opens by itself; 0 opens it only when asked
completion-enter"auto"lspWhat enter does in a completion menu: “first” puts in the first item, “selected” only one moved to with tab or the arrows (otherwise enter does what it does without a menu, like running a shell’s line), “auto” lets each source say: the shell “selected”, language servers “first”
diagnostic-messagestruelspShow each line’s worst problem after the end of the line
editing-style"helix"coreHow editing works: helix, vim, vscode or another style a plugin adds (see :style)
effectsfalsecoreSmall animations, like a wave of light through the status line when you switch files
flash-duration300flashHow long copied text flashes, in milliseconds
float-layout"free"panesHow new tabs lay out their floating views: “free”, “one”, “tiled”, “cascade” or your own
format-on-savetrueformatFormat files when they’re saved
grammar-downloadtruelanguagesDownload the grammar for a language Greed has none for when a file in it opens
gui-font""coreThe font the window draws text in, by family name; empty for the system’s monospaced font
gui-font-prose""coreThe proportional font the window draws prose in (styles with font = “prose”, like Markdown’s text), by family name; empty for the system’s sans-serif
gui-font-size15coreThe size of the window’s text in pixels, before the screen’s scale; zooming gives a window a size of its own
indent" "coreOne level of indent, spaces or a tab, in languages that don’t set their own
jump-label-alphabet"abcdefghijklmnopqrstuvwxyz"coreThe letters jump labels are made of, most comfortable first
line-numbers"absolute"coreHow line numbers count: “absolute”, “relative” to the cursor’s line, or “hybrid” (relative, with the cursor’s line its own number)
link-opener""coreWhat opens a link, e.g. “firefox”; empty for xdg-open, or open on macOS
markdown-looktruemarkdownShow Markdown with its markup hidden and its headings, code and quotes drawn as such
motion-hintsfalsecoreNumber the next places a word motion would go, and go there on a digit
notes-concealtruenotesShow links in notes without their brackets, and markup as symbols
notes-everywherefalsenotesTreat every Markdown file as a note: concealed links and backlinks
notes-folder"~/notes"notesThe folder notes live in; ~ is your home folder
notes-project-folder".greed/notes"notesWhere a project keeps its notes, in the project: they’re named project:NAME, and the plan and decisions you share with agents are among them
notes-remind-desktoptruenotesShow reminders as desktop notifications with notify-send or osascript, where installed
notes-remind-time"09:00"notesWhen a reminder with a date and no time goes off, as HH:MM
notes-search-case"ignore"coreHow searching notes minds case: “smart” (only when what you type has a capital letter), “ignore”, “match”, or “default” for as search-case says
on-quit"auto"coreWhat :q on the last project does to the session: “auto” ends it unless something is running (a command in a terminal, an agent at work) and keeps it then, “end” always ends it, “keep” always leaves it running to attach to again
on-quit-remote"keep"coreLike on-quit, when you’re attached over greed ssh
pane-layout"manual"panesHow new tabs arrange their panes: “manual”, “main-stack”, “columns”, “spiral” or your own
pipe-model-role"fast"pipeThe model role | model: ... asks; see :models
restore-sessiontruerestoreOpen the files a session had open when it starts again
search-case"smart"coreHow searches you type mind case, unless their kind says otherwise: “smart” (only when what you type has a capital letter), “ignore” or “match”
session-idle-hours24coreA session nothing is attached to, with nothing running and nothing unsaved, ends after this many hours; 0 keeps it
setup-first-starttruesetupShow the setup page the first time a terminal or window attaches without a config
shell-agent-max-output30000shellHow many bytes of a command’s output and of its errors the shell tools give an agent: the start and the end, with what’s between left out
shell-aliasestrueshellWhether a line can start with one of your shell’s aliases, read once from its startup files
shell-ask-role"fast"shellThe model role a line ending or starting with ? asks for a command; see :models
shell-completion-sources"cobra fish carapace man help"shellWhere a shell completes a program’s arguments from, in order: cobra, fish, carapace, man, help
shell-completion-timeout2000shellMilliseconds a program asked for completions (kubectl, fish, carapace, –help) gets to answer
shell-confirm-lines5shellRunning a prompt of more lines than this asks first, as after pasting a transcript
shell-editortrueshellWhether programs you run in a shell, like git commit, open files to edit in Greed: $EDITOR, $VISUAL, $GIT_EDITOR, $JJ_EDITOR and $KUBE_EDITOR are greed edit –wait
shell-environments"devenv direnv"shellWhich environments a shell loads in folders that bring one, in order, the first that applies winning: devenv, direnv, and those plugins add; empty for none
shell-fallback""shellThe shell that runs lines with pipes, globs and the like, e.g. “bash”; empty for your $SHELL (sh unless it’s sh, bash, zsh, dash, ksh, fish or nu)
shell-fallback-rcfalseshellWhether the shell running those lines reads its startup files (-i), for your aliases and functions
shell-filter-search-case"ignore"coreHow filtering a shell block with / minds case: “smart” (only when what you type has a capital letter), “ignore”, “match”, or “default” for as search-case says
shell-fold-lines0shellA block that printed more lines than this folds as it ends, unless it failed; 0 never
shell-fold-olderfalseshellRunning a command folds the finished blocks above it, except those that failed
shell-help-completion"on-flag"shellWhen a shell runs a program with –help to complete its flags: on-flag (when you press tab on one) or never
shell-help-never"reboot shutdown halt poweroff init telinit kill killall pkill"shellPrograms a shell never runs with –help to complete their flags
shell-history-size5000shellHow many commands typed at shells are kept
shell-icons"plain"shellThe icons of a shell’s own segments: “plain” ones any font has, or “nerd” ones a Nerd Font has
shell-max-lines5000shellHow many lines of a block’s output a shell shows: the first half and the latest half
shell-max-record8388608shellHow many bytes of a block’s output its record keeps; the rest goes to a file in the cache folder
shell-production-contexts"prod"shellPatterns for kubernetes contexts a shell’s prompt warns about, like prod; space between them
shell-prompt"greed"shellWhat draws a shell’s prompt before its ❯: “greed” (its own segments and folder) or “starship” (your starship prompt, when starship is installed)
shell-suggestionstrueshellWhether a shell’s prompt suggests the rest of a command typed before, after the cursor
shell-watch-minutes60shellHow long a shell’s watch runs before it stops by itself, in minutes; 0 for until it’s stopped
statusline-caps"round"statuslineThe ends of status line pills: “round” (needs a Nerd Font) or “none”
statusline-pillsfalsestatuslineShow the mode, tab, machine and session in the status line as pills in their colors
substitute-previewtruecmdlineShow what :s will change as you type it, before it runs
substitute-search-case"match"coreHow :s minds case: “smart” (only when what you type has a capital letter), “ignore”, “match”, or “default” for as search-case says
terminal-scrollback10000terminalHow many lines that scrolled off a terminal’s screen are kept
terminal-shell""terminalWhat a new terminal runs, e.g. “fish -l”; empty for your $SHELL
text-width80coreHow wide :reflow (and Vim’s gq) makes lines
tree-icons"none"treeIcons by the names in the file tree: “none”, or “nerd” for a Nerd Font’s
vcs-signstruevcsShow signs beside lines changed since the last commit
web-search""agentThe search service agents search the web with: “brave”, “exa”, “tavily” or “searxng”; empty for none
web-search-url""agentWhere your SearXNG is, for web-search searxng