# BitUpdate Creator Edition | Shortcuts Library

> A fast way to update your shortcuts + powerful developer tools

## What this shortcut does

BitUpdate Custom is down. Use 1.9.2 until further notice.
About
BitUpdate
is my updater shortcut that is very simple to use and has a ton of useful developer features, like posting updates and announcements.
Overview of features:
Super simple integration
Skip and unskip updates
Rollback support
Announcements with custom version matching
Output codes and preference values for more control
Optional offline/blocked network continuation
Won't break shortcuts that are run on Apple Watch
Version posting via the official API (requires API key) for updates and announcements
Shortcut Notification Service integration for notifying users about your updates
~~Custom server for handling requests~~ Currently down due to the Pro Updater API also going down, and the official API has a captcha on it for some reason. Use version 1.9.2 until this is resolved.
And much more!
Works for iOS 15 and above!
When run on an Apple Watch, this shortcut will exit immediately and output CANCELLED.
Setup
BitUpdate requires a dictionary with 3 keys:
Name (text): The name of your shortcut
Version (text): The current version of your shortcut
ID (number): The ID of your shortcut for getting the correct link.
prefs (text array): Optional. See Advanced/prefs.
If you would like to support both the regular and lite versions of BitUpdate, use this code:
Don’t forget to pass the Shortcut Info dictionary through the Run Shortcut action!
Your shortcut must be published for this shortcut to work.
Bugproofing
To make sure that the shortcut doesn’t throw any errors, make it check that the user has BitUpdate installed. If they don’t, simply ask to redirect them to the download page. If they do, the shortcut should continue as normal, checking for updates without issue.
(on the off chance there is an issue, let me know)
Networks that Block
If you come across any WiFi networks where is blocked, you can add it to the Blocked WiFi Networks in the setup page.
Checking for an Update
To check for an update in BitUpdate, just run it without passing any input through it.
Managing Skipped Updates
If you would like to continue to receive update screens for certain shortcuts, you may want to use this.
Run BitUpdate without any input and tap "Manage skipped updates"
Select a shortcut
BitUpdate will delete the shortcut’s skipped versions file.
Banner
Use this Markdown to ensure that your users download my shortcut! You can also copy it from the no-input menu when you run BitUpdate.
[![install bitupdate](https://i.imgur.com/3oYeSbh.png)](
Advanced
Extra features to enhance the user experience.
Creating updates and announcements from BitUpdate
You can now create announcements and versions within BitUpdate*!
When you create an announcement, it grabs your selected shortcut’s announcement regex and also grabs its iCloud URL so you don’t have to! One limitation to this feature is that your announcement title can’t be more than 10 characters long.
When you create an update, you will be asked for the iCloud URL, version, and release notes.
* Requires API key
Announcements
Announcements are a new way of notifying your users of a change. All you have to do is this:
Open up your shortcut, and in the Shortcut Info dictionary, create an array and call it
prefs
Go inside the array and create a string. Type
ANCMT::
, and then something that your announcements will be called. Example string:
ANCMT::ANNOUNCEMENT
Open up and tap
Create Version
on one of your shortcuts
Set the version number to whatever that string is. Exclude
ANCMT::
Enter in the rest of the information for the version, like the iCloud link and the announcement itself
This is what an announcement should look like if everything is set up correctly:
If you want to do something more advanced, you can set what you want to call your announcements to be a Regular Expression. An example like this:
ANCMT::^Announcement for version ([0-9]{1,2}(?>\.[0-9]{1,3}){0,2})
Would match version numbers like
Announcement for version 1.3.2
and would trigger an announcement in BitUpdate.
One annoying part about the API is that you can’t set a version name that’s longer than 10 characters with it.
If you are having trouble, you can contact me in the comments or by email.
prefs
These are what goes in the
prefs
key of the
Shortcut Info
dictionary.
OFFLINE::NORUN
— This will only allow the shortcut to run when connected to WiFi. Will output
CANCELLED""OFFLINE
.
See: Output Codes
ERR::SHOW
— Will show any API errors when they happen, as well as output details about the error.
NOCHECK
— Will not check for an update regardless of internet connection. (1.2.1 and later)
ANCMT::[regex]
— Sets the format for your shortcut’s announcement title. Supports regular expressions (1.6.1 and later).
SILENT
— No update banner will show, but it will still output the update results. (1.11 and later)
FORCEUPDATE
— Will show the update banner regardless of whether the most recent update/announcement was skipped/dismissed. (1.8.3 later)
Output Codes
You can use these to display custom messages after it runs to inform the user of things. Some parts of the output codes require version 1.11.3 or later.
UPDATED
— When the shortcut is running the latest version. (1.3 and later)
SKIPPED""[version]
— When the shortcut detects a skipped version or beta version (if Allow Beta Versions is off) (1.9.1 and later)
ANNOUNCEMENT
— When BitUpdate detects an announcement (1.6 and later)
DOWNLOAD
— When the user taps “Download” from the update menu.
CANCELLED""[reason]
— When something causes it not to update, like no internet connection. (not on error)
FAILED""[details]
— When an API error occurs.
Questions? Comments?
If you have any questions, you can contact me in the comments or by email.
For help with regular expressions, you can visit regex101 to play around with them or go to W3Schools for a tutorial.
Downloads
Action count as of 1.11.1: 432

## Compatibility

iPhone, iPad, Apple Watch

## Required apps



[View this page](https://shortcutlibrary.app/shortcuts/bitupdate-creator-edition)

[Download Shortcuts Library on the App Store](https://apps.apple.com/app/id6759494377)
