Automation
Mudlark supports the mudlark:// URL scheme, so you can control it from Apple Shortcuts, shell scripts, or any app that can open URLs. It also supports the x-callback-url convention for chaining actions.
Actions
Each action is a path in the URL. Parameters are passed as query string values. All text values should be percent-encoded.
create
Create a new note.
| Parameter | Required | Description |
|---|---|---|
| title | No | Note title |
| text | No | Initial content |
mudlark://create?title=Meeting%20Notes&text=%2B%20Follow%20up
open
Open an existing note by title or UUID.
| Parameter | Required | Description |
|---|---|---|
| title | No | Note title (fuzzy matched) |
| uuid | No | Note UUID |
mudlark://open?title=Meeting
addText
Append text to the current note or a specific note.
| Parameter | Required | Description |
|---|---|---|
| text | Yes | Text to append |
| title | No | Target note title |
| uuid | No | Target note UUID |
mudlark://addText?text=%2B%20New%20task
get
Get the contents of a note.
| Parameter | Required | Description |
|---|---|---|
| title | No | Note title |
| uuid | No | Note UUID |
| format | No | Output format: raw, markdown, or rendered |
mudlark://get?title=Meeting&format=markdown
list
List all notes.
| Parameter | Required | Description |
|---|---|---|
| format | No | Output format: json or text |
mudlark://list?format=json
search
Search across all notes.
| Parameter | Required | Description |
|---|---|---|
| query | Yes | Search query |
mudlark://search?query=deadline
export
Export a note to a destination app or format.
| Parameter | Required | Description |
|---|---|---|
| title | No | Note title |
| uuid | No | Note UUID |
| format | No | Export format: markdown, plain, or rendered |
| destination | No | Target app (e.g. obsidian, bear, drafts) |
mudlark://export?title=Meeting&destination=obsidian
x-callback-url
Mudlark supports the x-callback-url convention. Add these parameters to any action to control what happens after it completes:
| Parameter | Description |
|---|---|
| x-success | URL to open on success |
| x-error | URL to open on failure |
| x-cancel | URL to open if the user cancels |
mudlark://create?title=Log&x-success=shortcuts://
This creates a note called “Log” and returns to Shortcuts when done.
Using with Shortcuts
In Apple Shortcuts, use the “Open URLs” action with a mudlark:// URL. For actions that return data (like get or list), use x-callback-url to pass results back to your shortcut.
Using from the terminal
Use the open command to trigger actions from a shell script:
open "mudlark://addText?text=Hello%20world"