|
| 1 | +# Using iOS Shortcuts with Mealie |
| 2 | + |
| 3 | +!!! info |
| 4 | + This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed! |
| 5 | + |
| 6 | +Don't know what an iOS shortcut is? Neither did I! Experienced iOS users may already be familiar with this utility but for the uninitiated, here is the official Apple explanation: |
| 7 | + |
| 8 | +> A shortcut is a quick way to get one or more tasks done with your apps. The Shortcuts app lets you create your own shortcuts with multiple steps. For example, build a “Surf Time” shortcut that grabs the surf report, gives an ETA to the beach, and launches your surf music playlist. |
| 9 | + |
| 10 | +Basically it is a visual scripting language that lets a user build an automation in a guided fashion. The automation can be [shared with anyone](https://www.icloud.com/shortcuts/94aa272af5ff4d2c8fe5e13a946f89a9) but if it is a user creation, you'll have to jump through a few hoops to make an untrusted automation work on your device. |
| 11 | + |
| 12 | +## Guide |
| 13 | + |
| 14 | +### Prerequisites |
| 15 | + |
| 16 | +Before setting up the shortcut, make sure you have the following information ready and easily accessable on your Apple device. |
| 17 | + |
| 18 | +1. The URL of your Mealie instance |
| 19 | +2. An API Token for your user |
| 20 | + |
| 21 | +### Setup |
| 22 | + |
| 23 | +On the Apple device you wish to add the shortcut to, click on [this link](https://www.icloud.com/shortcuts/f6a15e7751d247098bfdc2df3793367f) to begin the setup of the shortcut. |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +Next, you need to replace `url` and `port` with the information for your Mealie instance. |
| 28 | + |
| 29 | +If you have a domain that you use (e.g. `https://mealie.example.com`), put that here. If you just run local, then you need to put in your Mealie instance IP and the port you use (e.g. the default is `9000`). |
| 30 | + |
| 31 | + |
| 32 | + |
| 33 | +Next, you need to replace `MEALIE_API_KEY` with your API token. |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | +You may wish to [add the shortcut to your home screen](https://support.apple.com/guide/shortcuts/add-a-shortcut-to-the-home-screen-apd735880972/ios) for easier access. |
| 38 | + |
| 39 | +## Features |
| 40 | + |
| 41 | +- Share a website with Mealie to import via URL. |
| 42 | +- Share a recipe photo from photos to import via image (parsed via OpenAI). |
| 43 | +- Trigger the shortcut and take a photo of a physical recipe to import. |
| 44 | +- Trigger the shortcut to select a photo from your Photos app to import. |
| 45 | +- Trigger the shortcut to take a picture of a URL (like on the bottom of a printed recipe) to import. |
| 46 | + |
| 47 | + |
| 48 | +## History |
| 49 | + |
| 50 | +User [brasilikum](https://github.com/brasilikum) opened an issue on the main repo about how they had created an [iOS shortcut](https://github.com/mealie-recipes/mealie/issues/103) for interested users. |
| 51 | + |
| 52 | +This original method broke after the transition to version 1.X and an issue was raised on [Github](https://github.com/mealie-recipes/mealie/issues/2092) GitHub user [Zippyy](https://github.com/zippyy) has helped to create a working shortcut for version 1.X. |
| 53 | + |
| 54 | +When OCR was removed from Mealie, GitHub user [hunterjm](https://github.com/zippyy) created a new shortcut that uses Apple's built-in OCR and Google Gemini to enhance and replace that functionality. |
| 55 | + |
| 56 | +When Mealie introduced image parsing via OpenAI, GitHub user [joschkarick](https://github.com/joschkarick) adjusted the shortcut to make use of the new recipe/create/image API. |
0 commit comments