cherri

README

Cherri

Cherri (pronounced cherry) is a iOS Siri Shortcuts programming language, that compiles directly to a valid runnable Shortcut.

🌟 Top Features

• 🎓 Easy to learn and syntax similar to other languages
• 🐞 1-1 translation to Shortcut actions as much as possible to make debugging easier
• 🪄 No magic variables syntax, they're constants instead
• 🪶 Optimized to create small as possible Shortcuts and reduces memory usage at runtime
• #️⃣ Include files within each other for large Shortcut projects
• 🔧 Define your own custom actions to paste actions
• 🥩 Enter actions raw with custom identifier and parameters
• ❓ Define import questions
• 📇 Generate VCards for menus
• 🔢 Strongly statically typed with type inference

Learn more

• 🛝 Playground
• 📄 Documentation
• 🧑‍💻 Code Tour
• 🗺️ Idealistic roadmap

📣 WIP 📣

This project has not yet reached a stable version. It is under heavy development and backward incompatible changes may be made.

Usage

cherri file.cherri

Run cherri without any arguments to see all options and usage. For development, use the --debug (or -d) option to print stack traces, debug information, and output a .plist file.

Why macOS only?

Generating valid Shortcuts is only possible on macOS. However, I am hoping to add a signing server to the web editor that will turn out valid Shortcuts on any platform with a web browser.

Development on other platforms

As it stands, I don't want someone to get confused and think Shortcuts compiled using Cherri on other platforms will run on their Mac or iOS device. However, you can build the compiler for your platform, it will just skip signing the compiled Shortcut, so it will not run on iOS 15+ or macOS 12+. Also, note that the compiler is primarily developed and tested on Unix-like systems.

Read my full thoughts on this

Why another Shortcuts language?

Because it's fun :)

Some languages have been abandoned, don't work very well, or no longer work. I don't want Shortcuts languages to die. There should be more, not less.

Some stability comes with the project being on macOS and not iOS.

Community

• VS Code Syntax Highlighting (Github)

Credits

Reference

• zachary7829/Shortcuts File Format Documentation
• sebj/iOS-Shortcuts-Reference
• [Tip] Reducing memory usage of repeat loops

Inspiration

• Go syntax
• Ruby syntax
• ScPL
• Buttermilk
• Jelly

---

The original Workflow app assigned a code name to each release. Cherri is named after the second to last update "Cherries" (also cherry is one of my favorite flavors).

This project started on Oct 5, 2022.