Shortcuts Reference

iOS macOS

This page is a mirror of the description, parameter and result information for Shortcuts actions published by Drafts. You can browse and use this same information in the Shortcuts app while building shortcuts. For example shortcuts and other integration information, see the Shortcuts page.

Table of Contents

1. Actions
   1. Get Action
   2. Run Action on Draft
   3. Run Action with Text
2. Capture
   1. Capture Text
   2. Quick Capture
3. Commands
   1. Toggle Action List
   2. Toggle Draft List
   3. Toggle Link Mode
   4. Toggle Pin Mode
   5. Toggle Tag Filters
4. Drafts
   1. Append to Draft
   2. Change Draft Syntax
   3. Create Draft
   4. Create Draft with Dictation
   5. Duplicate Draft
   6. Edit Draft
   7. Flag Draft
   8. Get Current Draft
   9. Get Draft
   10. Get Draft Versions
   11. Get Draft by UUID
   12. Move Draft
   13. Open Draft
   14. Prepend to Draft
   15. Save Draft Version
   16. Show Draft
   17. Update Draft
5. Search
   1. Search Drafts
   2. Show Command Palette
   3. Show Quick Search
6. Utility
   1. Apply Template
   2. HTML to Markdown
   3. Markdown to HTML
   4. Set Theme
7. Workspaces
   1. Get Drafts from Workspace
   2. Get Workspace
   3. Open Workspace

Actions

Get Action

Retrieves an action.

• Result
  • Found Action

Run Action on Draft

Run action on specified draft.

• Result
  • Action Result

Run Action with Text

Run action using provided text.

• Result
  • Action Result

Capture

Capture Text

Capture text as new draft.

• Parameters
  • Content: The content of the draft.
• Result
  • Captured Draft

Quick Capture

Show quick capture.

Commands

Toggle Action List

Change visibility of the action list.

• Parameters
  • Visibility: Visibility of action list.

Toggle Draft List

Change visibility of the draft list.

• Parameters
  • Visibility: Visibility of draft list.

Toggle Link Mode

Change status of Link Mode in the editor.

• Parameters
  • Status

Toggle Pin Mode

Change status of Pin Mode in the editor.

• Parameters
  • Status

Toggle Tag Filters

Change visibility of the tag filters.

• Parameters
  • Visibility: Visibility of tag filters.

Drafts

Append to Draft

Append content to a draft.

• Parameters
  • Draft: A draft to update.
  • Content: The text
• Result
  • Appended Draft

Change Draft Syntax

Change syntax assigned to a draft.

• Parameters
  • Draft
  • Syntax: Syntax definition to assign.
• Result
  • Modified Draft

Create Draft

Create new draft with options.

• Parameters
  • Content: The content of the draft.
  • Tags: Tags to assign.
  • Folder: Folder location.
  • Flagged: Flagged status.
  • Syntax: Syntax highlighting definition to assign.
• Result
  • Created Draft

Create Draft with Dictation

Open directly to dictation of a new draft.

• Parameters
  • Locale: Initial locale for dictation.

Duplicate Draft

Create a duplicate of an existing draft.

• Parameters
  • Draft
• Result
  • Duplicate Draft

Edit Draft

Edit draft properties.

• Parameters
  • Draft: Draft to update.
  • Property
  • Content
  • Folder
  • Is Flagged
  • Tags
  • Syntax
• Result
  • Modified Draft

Flag Draft

Flag a draft.

• Parameters
  • Draft
  • Flag Status
• Result
  • Modified Draft

Get Current Draft

Retrieve active draft from editor.

• Result
  • Current Draft

Get Draft

Retrieves a draft.

• Result
  • Retreived Draft

Get Draft Versions

Retrieves version history of a draft.

• Result
  • Draft Versions

Get Draft by UUID

Retrieves a draft using its unique identifier.

• Parameters
  • UUID: Unique identifier of the draft.
• Result
  • Draft

Move Draft

Update draft folder and other properties without updating content.

• Parameters
  • Draft: Draft to move.
  • Folder: Folder to assign.
  • Is Flagged: Flagged status.
  • Tags: Tags to apply.
  • Draft: Draft to move.
  • Draft: Draft to move.
  • Draft: Draft to move.
• Result
  • Moved Draft

Open Draft

Open a draft with options.

• Parameters
  • Draft
  • Draft List: Visibility of draft list.
  • Action List: Visibility of action list.
  • Load Workspace: Workspace to apply to draft list.
  • Load Action Group: Load an action group in the action list.
  • Load Action Bar Group: Load an action group in the action bar.

Prepend to Draft

Prepend content to a draft.

• Parameters
  • Draft: A draft to update.
  • Content: The text
• Result
  • Prepended Draft

Save Draft Version

Save version to the version history.

• Result
  • Draft Version

Show Draft

View content of a draft.

Update Draft

Update content and other properties of a draft.

• Parameters
  • Draft: A draft to update.
  • Content: The text
  • Update Type: The type of update to apply.
  • Tags: Tags to assign.
  • Folder: Move the draft to a folder.
  • Flagged: Update flagged status.
  • Syntax: Assign a syntax definition.
• Result
  • Modified Draft

Search

Search Drafts

Run a search and return matching drafts.

• Parameters
  • Search: Query string.
  • Folder: Limit search to a specific folder.
  • Tag filter: Comma-separated list of tags to include. Supports using “!” to omit a tag.
  • Flag status: Limit results by flagged status.
  • Sort order
  • Sort descending
  • Sort flagged to top
  • Limit: Maximum number of results to return.
• Result
  • Found Drafts

Show Command Palette

Open to Command Palette.

Show Quick Search

Open to Quick Search.

Utility

Apply Template

Pass text through the Drafts template engine.

• Parameters
  • Template: The input template to process.
  • Draft: The draft in context when evaluting template.
• Result
  • Template Output

HTML to Markdown

Convert HTML text to Markdown.

• Result
  • Markdown Text

Markdown to HTML

Convert Markdown text to HTML.

• Result
  • HTML Text

Set Theme

Change current theme and theme mode.

• Parameters
  • Theme Mode: Active theme mode
  • Light: Theme to use in light mode
  • Dark: Theme to use in dark mode

Workspaces

Get Drafts from Workspace

Retrieve drafts matching the filters of a workspace.

• Parameters
  • Workspace
  • Folder: Limit results to only drafts in a specific folder.
• Result
  • Workspace Drafts

Get Workspace

Retrieves an workspace.

• Result
  • Workspace

Open Workspace

Apply workspace to draft list.

---