Commands

open.code

Open a file inside the root in the code view, at line and column counted as a Pos is (from 0; the column in UTF-16 code units).

open.node

Open a node's page.

open.agent

Open an agent's page.

open.terminal

Show one of the plugin's own terminals (terminal.open's id) where asked, the bottom when not said. The daemon sends it unasked with each terminal a plugin opens, so every one is shown; a plugin sends it again only to move one.

Since API 0.2.

show.node

Show a node on the map.

action

Run one of the editor's actions on the allowlist (actions). args are for agent.new only: { worktree }, a path the roster or worktrees.list knows, where the composer of a new agent opens for the person to write and send.

message

Say something on the message line.

panel.show

Show one of the plugin's panels and focus it. With where = "tab" the panel opens as a tab of the centre beside files and agents, on a page's ground, the tab called by the panel's title beside its icon; with where = "dock", in the dock the layout or the manifest gives it. One view stands in one place: a panel moves out of the dock, float or tab it showed in to where it is asked for. With no where it is shown where it shows already, else where its manifest's dock says, and a [[panels]] table may say dock = "tab" (api 0.2). Closing its tab is hidden, as a dock that covers it is; the tab comes back after a restart, its last tree marked stale until the plugin answers, and closes, said once, where its plugin is gone.

panel.hide

Hide one of the plugin's panels.

panel.toggle

Show or hide one of the plugin's panels.

float.show

Show one of the plugin's views as a float over the focused pane.

float.hide

Put a float away.

picker.open

Open one of the plugin's pickers.

attach

Attach a node, a file inside the root, an agent, or (with agents:write, since 0.2) text to the composer; the chip names the plugin.

layout.use

Switch the window to one of its own named layouts (the [layouts.<name>] of its look's frame, as layout.next steps through them), or, with no name, back to the layout's own: its docks are shown and put away as that layout says, and panes, tabs and what they show stay. Honoured only in the answer to something the person did (a command, an act, a pick); from a timer, a write on the stream or any other event the app refuses it (command.refused) and says so. A name the window has no layout of is said, and nothing changes. The window's own named layouts are the allowlist: no other name switches anything.

Since API 0.2.

clipboard.write

Put text on the person's clipboard; needs clipboard:write, at most 1 MiB.

Since API 0.2.

edit

Change the text of a document open in the editor, as one undo step named after the plugin and label; needs docs:write. The edits are against version's text, do not overlap, at most 1,000 and 1 MiB inserted. Applied only if the document is still at version; either way the plugin hears document.edited.

Since API 0.2.

context.set

Set one of the plugin's own context keys, which a when clause tests: key is <plugin>.<name> (the plugin's name with - written _), value a bool, a number or a string of at most 256 bytes; null takes the key away. At most 64 keys a plugin; the editor keeps them until the plugin is switched off or removed.

Since API 0.2.

layer.enter

Put one of the plugin's own key layers ([[layers]]) on, above every key binding: honoured only in the answer to a command the person ran (a key, the palette, the command line, a click), in its hold or as its late result; from a timer, a write on the stream, an act or any other event it is refused (command.refused). While it is on, each of its keys runs its command with args [{...args, key}], the key in Vim notation; Escape, a key it does not bind (with leave = "other", and the key then goes on), its timeout or a change of the keys' mode leaves it, and the plugin hears layer.left.

Since API 0.2.

layer.exit

Take the plugin's own key layer nearest the top off; from anywhere.

Since API 0.2.