Sample Extension
The sample cmux extension and the template for new ones: a sidebar section built on the extension SDK, with no scopes.
cmux· 2 downloads · 0 stars· v1.0.0· Requires cmux 2.0 or later
Jot
Quick notes in your cmux sidebar: type one and press Return, tick it off when it is done, clear the done ones. Your notes stay when cmux restarts.
This is also the sample cmux extension: use it as a template ("Use this template" on GitHub, or
cmux ext new NAME --repo OWNER/REPO for a fresh one) and make it yours.
![]()
Install
cmux apps install github.com/manaflow-ai/cmux-extension-samplecmux shows what it asks for before it installs: Jot asks only to keep your notes
(storage:local). It reads nothing else and makes no network calls. Then place the Jot section
from the sidebar's edit mode.
Work on it
cmux ext dev # in this folder: validate, build, load, then reload on every saveEdit src/main.ts and save. Each save prints one line: reloaded in N ms, or the error with
its file and line (the last version that loaded stays on screen). While you work on it, cmux
loads it as local/cmux-extension-sample.
cmux ext dev --once --json # one validate + build + reload; exit 0 ok, 1 load, 3 no cmux, 4 manifest, 5 buildShare yours
cmux ext publish # checks it is ready to list and prints the steps
cmux ext pack # release/cmux-extension.tar.gz and release/cmux-app.v2.json, with the sha256A version is a GitHub release whose tag is the manifest's version (this one is 1.0.0) with the
two files cmux ext pack writes; cmux installs and updates from releases. To list it, open a pull
request to manaflow-ai/cmux-extensions adding the entry cmux ext publish prints to
extensions.json, and add the badge above to your README.
Files
cmux-app.json: the manifest (id, what it adds to cmux, the scopes it asks for).src/main.ts: the code. It importscmux-extension-sdk.dist/main.jsis built from it (bunon PATH; without it,dist/main.jsis loaded as it is). Commit both.sdk/:cmux-extension-sdkas the cmux that made this folder ships it.tsconfig.jsonpoints the import here, so nothing is installed from a registry.cmux-app.d.ts: the types of everything cmux gives the script;cmux ext devkeeps it matching the running cmux.icon.png: the icon in the App Store and on cmux.com.
License
MIT