Skip to content

Shortcuts & Automation

Shortcut Automations with Atlas in the Shortcuts app

Shortcut Automations with Atlas in the Shortcuts app

Atlas exposes its core actions to Apple's Shortcuts app and to Siri through App Intents. You can build shortcuts that create documents, pull text and statistics out of a project, edit content and metadata in batches, reorganize your work, and even arrange items on a canvas — then run them by tap, from a widget, on a schedule, or with your voice.

Requirements

Shortcuts support requires iOS 18, iPadOS 18, or macOS 15 or later. Atlas actions appear automatically in the Shortcuts app once Atlas is installed — there's nothing to enable.

A handful of actions ship as App Shortcuts, which means they work with Siri out of the box and appear in Spotlight. Just speak or type a phrase:

Action Try saying
Create Document "Create a document in Atlas"
Add Media Document "Add media to Atlas"
Get Project Documents "Get my Atlas documents"
Open Document "Open a document in Atlas"
Export as Markdown "Export an Atlas document as Markdown"
Clip Web Page "Clip a web page to Atlas", "Clip this page to Atlas", or "Save a web page to Atlas"
Get Web Clip "Get a web clip with Atlas" or "Get web page Markdown from Atlas"

Every other action listed below is available in the Shortcuts editor under Atlas, ready to drop into a shortcut of your own.

How Atlas Actions Work

Most actions share a few common ideas, so you don't have to relearn them per action:

  • Projects and documents are pickers. Actions that act on your content take a Project and/or a Document parameter. Tap the parameter to choose, or set it to Ask Each Time to be prompted when the shortcut runs.
  • An optional Project scopes the picker. Many actions accept an optional Project that simply narrows the document list — handy when you have a lot of projects and want the picker to show only one.
  • Batch by default. Editing and organizing actions accept a list of documents, so a single step can act on many documents at once. Set Metadata, Remove Metadata, and Restore Documents are all-or-nothing: if one document in the batch can't be changed, none of them are.
  • Actions return values. Most actions hand back the documents (or the file, text, or items) they produced, so you can chain one action's output into the next — for example, feed an exported file straight into the system Share action.

Return Values

When an action returns something — a document, a canvas, a list of items — Shortcuts keeps it as a variable you can reuse later in the shortcut. Tap that variable and pick a property to pull one specific value out of it instead of passing the whole result along. A returned Document, for instance, surfaces its Title, Document Type, Project, Tags, Groups, Canvas Items, Synopsis, creation and modification dates, and — when the document is a canvas — its Canvas.

A returned Document, accessing the Canvas to pass to a Canvas accepting input

A returned Document, accessing the Canvas to pass to a Canvas accepting input

That Canvas property is what bridges the two halves of Atlas. In the example above, a Find Document filter narrows to a single canvas-type document, and tapping its Canvas property hands that canvas straight to Get Items from Canvas — no separate lookup required. The relationship runs both ways:

  • From a document to its canvas — a canvas-type document exposes a Canvas property you can feed into Get Items from Canvas, Add to Canvas, or Manipulate Canvas Item.
  • From a canvas back to its document — a canvas exposes a Document property, so you can return to the underlying document to read its synopsis, set metadata, or export it.
  • From a canvas item to its document — a card returned by Get Items from Canvas carries a Referenced Document property, the document it points to, so you can chain into document actions. Its Referenced Document Title holds just the title.
  • From a document to the canvases it's on — a document exposes Canvas Items, the cards and pins that reference it on canvases that aren't in the Trash.
  • Between groups and items — a canvas group exposes a Canvas Item, the group's frame as an item, so you can open it, move it, or remove it. It also exposes Members, the items inside it. A canvas item that is a group exposes a Canvas Group, which feeds Open Canvas Group and the Groups filters.

Because every action that produces these entities returns them as variables, you can keep chaining: find a canvas document, get its items, filter to cards, and act on what they reference — all within one shortcut.

Action Catalog

Create

Action What it does Key inputs
Create Document Creates a text document, folder, or canvas in a project Document Type (Document / Folder / Canvas), Title, Project, Location (any document in the project), Content (Markdown, documents only), Tags
Add Media Document Imports a file as a media document Media (image, movie, audio, or PDF), Title (optional), Project, Location, Tags
Create Metadata Field Creates a project metadata field — or reuses the existing one if the name already exists Name, Type (Text, Number, Date, and so on), Project
Clip Web Page Clips a web page into a project as a Markdown document, using your clip templates Web Page, Project, Location, Append to Location, Template, Images, Tags, Add Suggested Tags, Save Web Page
Add Webpage Adds a web page to a project as a live web page item, without extracting its content Web Page, Title (optional), Project, Location, Tags

See Clipping Web Pages from Shortcuts for how each Clip Web Page parameter behaves.

Add Webpage keeps the page as a link you open in Atlas, where Clip Web Page saves a Markdown copy of its text. If you leave Title empty, Atlas uses the page's own title, then the site's host name, then "Untitled Webpage". An address without a scheme gets https://, and anything other than http or https is refused. If the Location is a canvas, Atlas also adds a card for the page. Tags must come from the chosen project.

Details

Action What it does Key inputs
Get Document Text Reads a text document's Markdown and returns it as text Document, Project (optional)
Get Document Metadata Returns the metadata field/value pairs set on a document Document, Project (optional)
Get Document Statistics Returns word, character, sentence, and paragraph counts, plus Reading Time (Minutes) Document, Project (optional)
Get Goal Progress Returns where the writing goal on a document or folder stands Document, Project (optional)
Get Web Clip Clips a web page with your clip templates and returns its title and Markdown without saving anything to Atlas Web Page, Template (optional)
Get Project Documents Lists a project's documents, newest first Project, Document Type (optional filter), Include Trashed
Get Project Tags Lists a project's tags, each with its hierarchical path Project

Text-only actions

Get Document Text, Get Document Statistics, and Export as Markdown work on text documents only. Pointed at a folder, canvas, sketch, media, or web page, they report an error rather than guessing.

Get Document Statistics counts the same way the Inspector does, so Markdown syntax, link URLs, and annotation text are left out. Reading Time (Minutes) is a whole number of minutes based on the reading speed you've chosen in the Inspector. It returns 0 for an empty document or one that reads in under a minute.

Get Goal Progress returns a Goal Progress value with these properties: Has Goal, Progress, Target, Unit, Target Comparison (About, At least, or At most), Repeats (Never or Every day), Status, Today's Target, Deadline, Current Streak, and Best Streak. Status is one of Keep going, Almost there, Goal reached, Under the limit, or Over the limit. Today's Target is set only for goals with a deadline, and the streaks only for goals with a daily target. Progress is measured in the goal's unit, which is minutes for reading time. An item with no goal returns Has Goal as false, so a shortcut can branch on it. It reads saved writing only, so text you're still typing in an open editor isn't included yet. See Writing Goals.

Get Web Clip returns a Web Clip with a Title, Markdown, Synopsis, Source URL, Site Name, and Word Count. It needs no project, saves nothing, and keeps images as links. Use it to feed a page's Markdown into another action, such as Edit Document Text, without creating a clip document first. If you pick a template that has since been deleted, the action reports "The selected clip template could not be found."

Edit

Action What it does Key inputs
Edit Document Text Sets, appends, or prepends Markdown on one or more documents Documents, Edit Mode (Set / Append / Prepend), Content, Section Title (optional heading), Project (optional)
Set Metadata Sets (or updates) a metadata field's value on documents Documents, Field, Value, Project (optional)
Add Tags to Documents Adds tags to a batch of documents Documents, Tags, Project (optional)
Remove Tags from Documents Removes tags from a batch of documents Documents, Tags, Project (optional)
Modify Document Property Sets a document's name, synopsis, or notes Documents, Property (Name / Synopsis / Notes), Value, Project (optional)
Remove Metadata Clears a field's value from documents — the field definition itself is untouched Documents, Field, Project (optional)

Values are entered as text

Set Metadata takes the value as text and checks it against the field's type before saving. If the value doesn't fit, the action fails with a message and writes nothing.

Field type Value format
Text Any text
List A JSON list of text, such as ["One","Two"]
Selection One of the field's options
Number Digits, such as 42 or 3.5
Checkbox true or false
Date 2026-10-20
Date and time 2026-10-20T14:30:00Z

Organize

Action What it does Key inputs
Move Documents Moves documents within their project to the Inbox or inside another document Documents, Destination (Inbox / Location), Location, Project (optional)
Move or Copy to Project Moves or duplicates documents, including folders and canvases, into another project Documents, Action (Move / Duplicate), Project (destination), Location (optional), Include Children, Include Canvas Items, Transfer Tags, Transfer Metadata
Move Documents to Trash Sends documents of any kind to the Trash Documents, Project (optional)
Restore Documents Restores trashed documents. If a document's folder is still in the Trash, the whole batch is refused until you restore that folder too Documents, Project (optional)

Move Documents accepts any document in the project as its Location. Moving a document into itself or into one of its own children fails.

Moving across projects

Move or Copy to Project works on text documents, media, web pages, folders, and canvases. Location defaults to the destination project's Inbox, and a Location that's in the Trash or in a different project falls back to the Inbox.

Include Children is on by default and brings a folder's contents along. Turn it off and a moved item leaves its children in the source project's Inbox, while a copy is made without them. Include Canvas Items is on by default and keeps the cards on a moved or copied canvas. Turn it off and those cards become labels. Transfer Tags and Transfer Metadata are on by default and create any tag or field the destination project doesn't have.

A move within the same project repositions the original and always brings its children. Duplicate makes a real copy at the Location, with its children unless Include Children is off.

Canvas

Action What it does Key inputs
Add to Canvas Adds a document card, pin, text block, or group to a canvas Canvas, Canvas Item Type (Card / Pin / Label / Group; Label is a text block), plus per-kind options: Document, Text, Shape, Icon, Style, Color, and X / Y position
Remove from Canvas Removes items from a canvas — the referenced documents are untouched Items, Canvas (optional), Project (optional)
Manipulate Canvas Item Moves, resizes, recolors, reshapes, or changes the icon or text of canvas items Items, Change (Move / Resize / Recolor / Reshape / Change Icon / Change Text), plus the matching value (X·Y, Width·Height, Color, Shape, Icon, or Text)
Get Items from Canvas Lists the cards, pins, text blocks, and groups on a canvas Canvas, Canvas Item Type (optional filter), Group (optional filter), Project (optional)
Get Groups from Canvas Lists the groups on a canvas, including nested groups Canvas, Project (optional)
Get Items in Groups Lists the items inside one or more groups, nested groups included, without needing a canvas Canvas Groups, Canvas Item Type (optional filter)
Get Canvas Items for Documents Lists the cards and pins that reference the documents, on canvases that aren't in the Trash Documents, Canvas (optional), Canvas Item Type (optional filter)

Get Items in Groups chains straight off Find Canvas Groups or any Groups output, which makes it the quickest way to act on what's inside a group. Groups appear as a canvas item type. A returned canvas item exposes Group Members (the items inside a group, including nested groups) and In Groups (the groups an item sits in). Set the Group input on Get Items from Canvas to limit the results to the items inside one group, nested groups included. A group from a different canvas is refused.

Only pins have a shape or an icon, so Reshape and Change Icon in Manipulate Canvas Item work on pins only. Using them on a card, text block, or group fails the whole batch. Groups can still be moved, resized, and recolored. Recolor with no color chosen leaves an item's color unchanged. Leave X and Y empty in Add to Canvas and the item lands beside the canvas's newest card.

Open

Action What it does Key inputs
Open Document Opens a document in Atlas Document
Open Canvas Item Opens a canvas item in Atlas, focused on its canvas Canvas Item
Open Canvas Group Opens a canvas group in Atlas, framed on its canvas Canvas Group

Open Canvas Item and Open Canvas Group both frame a whole group when that's what you open, without zooming past actual size. Open Canvas Group takes the groups that Find Canvas Groups and the Groups outputs return, which Open Canvas Item doesn't accept.

Export

Action What it does Key inputs
Export as Markdown Exports a text document as a .md file and returns it Document, Include Front Matter (default on), Project (optional)

Export as Markdown runs the same pipeline as the Export Tool's Markdown export. It resolves {{title}} and other document variables, writes links to other documents as [[wiki-links]], removes the indent that Indent Wrapped Paragraphs adds, and points images at stable file names. Front matter is added if you leave it on. The action returns the .md text only, not an images folder. If the document can't be read, the action fails with an error instead of exporting an empty file.

Finding Items with Filters

The Shortcuts app's built-in Find action works with Atlas items. Add a Find action, choose an Atlas item type such as Document or Canvas Item, then choose Add Filter to narrow the results. When you pass items into a Find, Shortcuts words it as a filter instead ("Filter Canvas Items"). Shortcuts supplies the interface, and Atlas supplies the properties you can filter and sort by.

Find Filter by Sort by
Document Title, Document Type, Project, Tags, Groups, Date Created, Date Modified Title, Date Modified, Date Created
Canvas Item Canvas Item Type, Title, Referenced Document, Referenced Document Type, Groups, Canvas, Project Title, Canvas, Project
Canvas Group Name, Canvas, Project Name, Canvas, Project
Canvas Title Title
Project Title Title
Tag Name Name
Metadata Field Name Name

A few behaviors are worth knowing:

  • Match all or any. With more than one filter, choose whether an item must match all of them or any of them. With no filters, Find returns every item.
  • Text filters offer is, is not, contains, begins with, and ends with, and they ignore case. Canvas Group names and Canvas Item titles leave out "is not". Document Type, Canvas Item Type, and Referenced Document Type offer is and is not. Date filters offer is, before, and after.
  • Types. Documents are Document, Folder, Media, Canvas, Webpage, or Sketch. Canvas items are Card, Pin, Label, or Group. Referenced Document Type uses the document types, and it excludes labels and groups, since they don't reference a document.
  • Canvas Item Title. This filter matches an item's own text, such as a label's text, a group's name, or a pin's title, or the title of the document it references, so a plain card is found by its document's title. Sorting by Title uses the same value, with untitled items first when ascending and last when descending.
  • Groups. This filter limits results to items inside a group, nested groups included. On a document, it matches documents that appear as a card or a pin inside that group on any canvas.
  • Sorting. Choose a property and an order. Titles sort the way Finder does, so "Item 2" comes before "Item 10". With no sort chosen, Find Tags and Find Metadata Fields follow the order they have in Atlas.
  • Limit. Turn it on to cap the number of results. With it off, Find returns every match.
  • Scope. Find skips archived projects and trashed documents. Find Project lists active projects only.

For example, Find Canvas Items where Canvas Item Type is Card and Groups contains a group you choose returns every card inside that group. Find Canvas Items where Referenced Document Type is Webpage returns every card or pin that points to a web page.

Earlier versions called some of these properties Kind and Text. If you built a shortcut with those names, it keeps working, and it shows the new names.

Clipping Web Pages from Shortcuts

Clip Web Page runs the same clipping pipeline as the Web Clipper, without the clip sheet. That makes it a good fit for saving pages on a schedule, from a list of links, or as part of a larger shortcut. Siri can run it too, so you can say "Clip this page to Atlas."

Parameter What it does
Web Page The page to clip. Required; http and https addresses only
Project The project that receives the clip. Required
Location Optional document to place the clip under. Defaults to the project's Inbox. If the Location is a canvas, Atlas also adds a card linking to the clip
Append to Location Off by default. When on, the clip is added as a new section at the end of the Location, which must be a text document
Template Optional clip template. Leave it empty and Atlas picks one automatically, just like the Web Clipper: your custom templates first, then bundled ones, then Default
Images Use Template, Save, Link, or Remove. Defaults to Use Template, which starts from the template's image setting
Tags Optional tags from the chosen project. Ignored when appending
Add Suggested Tags Off by default. Adds the tags Atlas suggests for the page
Save Web Page Off by default. Also saves a linked web page item under the clipped document

The action returns the document it created or updated, so you can pass the clip to the next step.

Because nothing is shown for review, a few things differ from clipping in the Web Clipper:

  • There's no preview and no per-image choice. Save, Link, and Remove apply to every image, while Use Template follows the template's image setting. Icons and sidebar images are always left out.
  • If the template has errors, the action still saves the clip and tells you: "Clipped “…”, but the template had problems, so part of it may be missing." Get Web Clip reports the same.
  • There's no AI summary. The summarize and prompt template tags fall back to their non-AI behavior.
  • Atlas reads the page's server-rendered HTML only, so content that a page builds with JavaScript may be missing.
  • There's no text selection support; the whole page is clipped.

Preview documents

If you're using Atlas in Preview, each clip counts toward your Preview document limit, or two documents when Save Web Page is on. Appending to an existing document doesn't count. Add Webpage counts as one document, and Add Media Document counts toward the limit too. At the limit, the action reports that you've used all of your free Preview documents.

Worked Examples

Append a dated note to a running log

This shortcut adds a timestamped entry to the bottom of an existing document:

  1. Add a Text action (or Ask for Input) to capture what you want to record.
  2. Add the Edit Document Text action.
  3. Set its mode to Append, pick your log document, and set the content to the text from step 1.
  4. Optionally set a section title — the current date, say — so each entry gets its own heading.

Run it from the Home Screen, a widget, or by saying "Hey Siri" with your shortcut's name.

Export a draft and save it

Three actions which automatically Export draft documents

Three actions which automatically Export draft documents

This one turns any document into a Markdown file you can send anywhere:

  1. Add Export as Markdown and choose the document (or set it to Ask Each Time). Leave Include Front Matter on to carry tags and metadata into the file.
  2. Add the system Share (or Save File) action.
  3. The file returned by step 1 flows straight into step 2 — no extra wiring needed.

See Also

  • Exporting Your Work — The full export tool, and the Markdown frontmatter the Export as Markdown action produces
  • Metadata and Tags — Defining the fields that the metadata actions read and write
  • The Canvas — Cards, pins, and text blocks that the canvas actions manipulate
  • Metadata and Tags — How project-scoped tags behave