Shortcuts – FAQ

Atode App

Frequently asked questions about Shortcuts.

How can I use Apple Shortcuts?

A shortcut is a quick way to get one or more tasks done with your apps. The Apple Shortcuts app lets you create your own shortcuts with multiple steps.

Atode includes shortcuts to list or open articles and annotations and to export them in text, markdown or json format or save content as text and markdown. All shortcuts are available directly in the Apple Shortcuts app and can be freely combined with other actions. The provided shortcuts require at least iOS 17.4+ but some actions are only supported for iOS 18 or later.

Shortcuts
Find Articles List all articles or filter by properties (folder, tags, …).
Find Annotations List all annotations or filter by properties (type, folder, tags, …).
Launch App Open app destination (app, reader, library).
Continue Reading Continue reading your current article.
Current Article Get your current article.
Open Article Open article in the app.
Save Article Save article content as text or markdown.
Export Article Save article metadata and annotations in text, markdown or json format.
Current Annotations Get all annotations of your current article.
Open Annotation Open article annotation in the app.
Export Annotation Save annotation metadata in text, markdown or json format.
Readwise Service Upload annotations to Readwise service.

How can I use Shortcuts to bookmark articles?

The Bookmark shortcut lets you save an article for reading later. This action requires an url for input, that can be entered when running the shortcut or set from a variable of a previous step like the Get Clipboard action.

Bookmark article (example)

  1. Add Bookmark shortcut
  2. Set url or run to input a link

The bookmarked article is not available immediately. It will be processed later on by the app, either when running in the background or on the next launch.

How can I use Shortcuts to export articles?

Individual articles can be exported in text, markdown or json format with the Export Article shortcut. It can be used together with the Current Article or Find Articles action, which lets you get a filtered list of articles to automate saving metadata and annotations of all your articles.

Export article (example)

  1. Add Export Article shortcut
  2. Choose a format (text, markdown, json)
  3. Choose article or run to select from recents

Export current article (example)

  1. Add Current Article shortcut
  2. Add Export Article shortcut
    • Connect Current Article output to Export Article input
    • Choose a format (text, markdown, json)
  3. Add Save File shortcut from the Files app

Export all articles (example)

  1. Add Find Articles shortcut
    • Optional: Add Filter (tag, folder, …)
  2. Add Repeat with Each action for all articles
  3. Add Export Article shortcut inside the loop
    • Connect Repeat Item to Export Article input
  4. Use the Files app Save File action to save the export
    • Disable Ask Where to Save and select a folder instead
    • Enable Overwrite If File Exists to have only one copy

How can I use Shortcuts to save article content?

You can save article content as text or markdown with the Save Article shortcut.

Save article (example)

  1. Add Save Article shortcut
  2. Choose a format (plain text or markdown)
  3. Use the Files app Save File action to save the content

This shortcut lets you save the full article content as plain text or markdown for use in other apps. Like with any other shortcut, it can be used together with the Current Article or Find Articles action to select a specific article.

How can I use Shortcuts to export annotations?

You can export individual annotations in text, markdown or json format with the Export Annotation shortcut.

Export annotation (example)

  1. Add Export Annotation shortcut
  2. Choose a format (text, markdown, json)
  3. Choose annotation or run to select from latest

Another option is to create your own annotation export. You can use the Find Annotations shortcut to get a filtered list of all annotations or the Current Annotations action to save all annotations of your current book.

Export all annotations (example)

  1. Add Find Annotation shortcut
    • Optional: Add Filter (date, title, tag, …)
  2. Add Repeat with Each action for all annotations
  3. Add Dictionary and set properties from Repeat Item inside the loop
  4. Create new Dictionary action to save the export output in the required format

This example iterates over all annotations and creates a new dictionary for each entry with specific annotation properties. The result output can be used as a json payload to upload highlights to external services.

How do I use Shortcuts to upload highlights to Readwise?

Atode includes a convenience shortcut to upload highlights to the Readwise service. It can be used to upload all or selected highlights with the Find Annotations action or to just upload the Current Annotations of an article.

Upload highlights (example)

  1. Add Find Annotations shortcut
    • Optional: Sort by created or modified
  2. Optional: Add Choose from List shortcut
  3. Add Readwise Service shortcut
    • Connect list output to upload input
    • Enter your Readwise access token

Upload current highlights (example)

  1. Add Current Annotations shortcut
  2. Add Readwise Service shortcut
    • Enter your Readwise access token

You can obtain your personal Readwise access token from their service
https://readwise.io/access_token

How do I use Shortcuts to upload highlights to other services?

With Shortcuts, annotation export and upload to external services can be automated. Here is an example for Readwise, but the same concepts can be used for other service APIs as well.

Service upload (example)

  1. Add Find Annotation shortcut with optional filters
    • Sort by created or modified
    • Order by latest
    • Limit to 30
  2. Add Choose from List action to select some or all annotations
  3. Add a Repeat with Each action for the Chosen Items afterwards
  4. For each item, create a Dictionary with the highlight attributes
  5. Create new Dictionary action to save the export output in the required format
  6. Use a Get Contents of URL action and configure it to upload the highlights:
    • POST request to Service API endpoint
    • Request body type File set to the Text contents
    • Headers for json content type and authorization token

In summary, the shortcut transforms your annotations to the required json structure and uploads it to the Readwise highlights API endpoint. The text conversion is a workaround, because the Get Contents action somehow does not accept dictionaries for json body type inputs. This solution is based on the custom json payload approach published in Alex W.’s blog.

This approach will only work with more than one annotation. The problem is that the Shortcuts app somehow converts list output to an object instead of an array if there is only one item contained. You would need to modify the shortcut to handle zero/one or multiple annotations.

How you structure or upload highlights depends on the service. Refer to their documentation to learn more:

– Readwise
https://readwise.io/api_deets

– Raindrop.io
https://developer.raindrop.io/v1/highlights

Where can I find more information about Shortcuts?

For other questions or more details about Shortcuts, please refer to Apple’s official documentation and support.

Shortcuts User Guide:
https://support.apple.com/en-us/guide/shortcuts