Keys in Zed

In Org files the commands are in the code actions (editor: toggle code actions, ctrl-. or cmd-.), which list what applies where the cursor is, and Org's keys run them too once the two files of keys through tasks are pasted:

• In an Org file: change the TODO state (the next one, the previous one, or one picked from a list), the priority, the timestamp under the cursor; toggle a checkbox; a new heading, item or table row (as M-RET, M-S-RET, C-RET and C-S-RET make them), the cursor then in it; clock in and out; refile; archive; open the agenda (this week, the TODO list, or the agenda menu); capture.
• In a capture buffer: file the entry, give up, or refile it.

Bind editor::ToggleCodeActions to a key of your own if the menu is too far away.

What a command asks for is asked with buttons: a TODO state, a priority, a refile target, a capture template, yes or no. Zed has no box of its own for a server to ask for typed text, so the commands that want a date (schedule, deadline) or text (a template's %^{…} prompts, a tags search) say what they ask for and answer with a rename at the cursor: rename at the cursor (F2) and type the answer (+2d, fri 10:00, a search) for the new name. Zed sends no empty new name: - alone is the empty answer, the prompt's default (Insert link (default …), Table size Columns x Rows (empty for Org's default), today for a date). Until then a rename answers the question, not renames.

zed.org says how to install and set up the extension.

Keys through tasks#

An extension cannot bind keys, and a key of Zed's cannot run a language server's command, but it can run a task. Two files of the extension set that up, once (and again when they change, after an update):

1. tasks.json: a task for each command (Org: … and Org agenda: …). Paste its entries into your tasks (zed: open tasks, ~/.config/zed/tasks.json).
2. keymap.json: binds the agenda's keys, and Org's keys in Org files and capture buffers (ctrl-c ctrl-t, ctrl-c ctrl-c, ctrl-c ,, alt-enter, ctrl-c a, ctrl-c c and the rest), to those tasks. Paste its blocks into your keymap (zed: open keymap).

The tasks use none of Zed's $ZED_FILE or $ZED_ROW: Zed offers no task that uses them in a file outside the project, which the agenda and a capture buffer are. The server follows the cursor itself instead (from the highlights Zed asks for as it moves), and a task runs its command where the cursor last was: on the agenda's line in the agenda, at the cursor in an Org file. A key that means one thing in a capture buffer and another elsewhere, as ctrl-c ctrl-c files the capture there and toggles a checkbox or updates a block elsewhere, runs the command of the buffer the cursor is in.

ctrl-c ctrl-c in a capture buffer files the entry, ctrl-c ctrl-k gives up and ctrl-c ctrl-w refiles it. Its tab stays open afterwards, as Zed lets no server close one; close it with ctrl-w and do not save it.

Opening the agenda#

The agenda, the TODO list, the agenda menu and capture need no Org file open: run them from the task picker (task: spawn, alt-shift-t on Linux; type Org:) anywhere, or with ctrl-c a and ctrl-c c in an Org file or the agenda. When no server runs yet, the task opens the Org file you last opened, in its folder, with Zed's command line (found beside Zed, or zed or zeditor on PATH; on macOS run cli: install once), which starts one, and then runs the command there.

The agenda is a file the server writes, ~/.local/state/org-lsp/agenda/…/Agenda.org-agenda (the same one for the same project folders), opened as Org; the server writes it again when it changes. It is not read-only, as Zed refuses a rename in a read-only file, and a rename answers what the agenda's commands ask; text typed in it by mistake keeps Zed from reading it again (undo it). When Zed starts again with the agenda's tab open, the new server takes the tab over: it shows the agenda of the current week, and its keys work.

How the tasks run#

A task's terminal stays out of sight unless the command fails.

The tasks are yours rather than the extension's because Zed offers an extension's tasks only in files of the project's folders, and the agenda is a file of the server's own, elsewhere: a key bound to one would open the task picker instead. Each task runs ~/.local/state/org-lsp/agenda-command, a script the server writes, which runs the command where the cursor is: the server follows the cursor through the document highlights Zed asks for when it moves (after lsp_highlight_debounce, 75 milliseconds). With agendas open in several windows, the keys act on the one the cursor was last in. The script stays when Zed quits, so that the tasks can start a server.

On Windows, where the script is agenda-command.cmd under your user folder and the shell is PowerShell, make each task's command & "$HOME/.local/state/org-lsp/agenda-command.cmd" org.agenda.later (with its own command at the end).

The keys#

The agenda has the same keys as in every editor, Emacs's agenda keys, with J for a date and the views under v (v d, v w), so that Vim mode keeps its motions.

In the agenda#

¦ stands for |, which an Org table cannot hold.

In Org files#

¦ stands for |, which an Org table cannot hold.