API Reference

Muxy injects a muxy object into extension code. On pages, most calls return a Promise. In scripts and background scripts, most calls are synchronous. Exceptions are noted where they apply, such as execAsync, which returns a handle whose result you await.

const tabs = await muxy.tabs.list();   // page
const tabs = muxy.tabs.list();         // script or background

Most calls need a permission. Errors throw (or reject) with a message.

Availability

Scripts and background scripts also have setTimeout, setInterval, and their clear functions.

Workspace

send and sendKeys only reach panes that are on screen. For a hidden pane, readScreen returns the text it last showed.

Running programs

const result = await muxy.exec(["git", "status", "--short"], { cwd: "src" });
const result = await muxy.exec({ shell: "ls | wc -l" });
// { stdout, stderr, exitCode, timedOut, truncated }

• Runs on the project's server, in the project folder, with your login PATH and MUXY_EXTENSION_ID set.
• Options: cwd, env, stdin, timeoutMs (default 30 s, up to 300 s).
• Output is capped at 4 MiB per stream.
• execAsync(...) returns { id, result, cancel } right away, so a page or script can cancel a long run.

Storage

A small key-value store per extension, kept after uninstall.

await muxy.storage.set("count", 3);
await muxy.storage.get("count");   // 3, or null
await muxy.storage.delete("count");
await muxy.storage.keys();         // sorted keys

Values are JSON, up to 1 MiB each and 5 MiB in total.

Web requests

http.fetch(url, { method, headers, body, timeoutMs }) resolves to { status, headers, body, truncated }. It runs in the app, asks the user per host, and can't reach the local machine or private networks. Response bodies are capped at 10 MiB and timeouts at 120 s. Pages only.

Notifications

• notifications.notify({ title, body }) posts a notification and the notification.posted event.
• toast({ title, body }) does the same from pages and scripts.

Shortcuts

shortcuts.register({ id, combo }) binds a key while the extension runs. Pressing it sends the command.<id> event to the extension. Commands in the manifest use defaultShortcut instead. combo looks like cmd+shift+e or opt+left and needs cmd, ctrl, or opt. unregister(id) and list() manage them.

GitHub

gh.user() returns the signed-in GitHub user from the gh CLI on the desktop computer, even for remote projects. It is cached for five minutes.

Page only

More: Events, Tabs, Panels, Bar items, Dialogs, Files, Git.