Skip to content

Lathryx/Scriptable-Getting-Started-Guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 

Repository files navigation

What is Scriptable?

Scriptable Icon

Scriptable is a mobile application for iOS created to enable anyone to easily integrate with the iOS backend. Its simple syntax allows for lots of flexability. Scriptable uses Javascript. Scriptable allows for developers to prototype, test, preview, and much more. It was developed by Simon B. Støvring, the creator of various other apps such as Jayson and Data Jar.

Scriptable, according to their official website, currently consists of the following features:

Plain Javascript

  • Supports JavaScript ES6. Scripts are stored as plain JS files on disk.

Native APIs

  • Integrate with the native APIs of iOS directly from JavaScript.

Siri Shortcuts

  • Run scripts from Siri Shortcuts. Present tables, websites, HTML and more in Siri.

Documentation

  • All native APIs that are bridged to JavaScript have documentation which is available offline.

Share Sheet Extension

  • Run a script from a share sheet and process the inputs.

Files Integration

  • Integrated with the file system and Files.app enabling you to perform operations on files.

Customizable

  • The editor can be customized to match your preferences.

Example scripts

  • Comes with several example scripts to get you started.

x-callback-url

  • Communicate with other apps using x-callback-url.

By using Scriptable, you have the benefit of easily integrating with iOS without the need for a Developer license; it's a great tool for the average consumer, or a full-time developer.

Getting Started

Though Scriptable has its own documentation, found here, it could be difficult to get started using their API. This guide will act to help with that.

This guide assumes the following:

Further updates, announcements, or assisstance can be found on the unofficial Scriptable subreddit and Discord server.

Helpful Links of Information

Below is a list of links containing information that may help while you are programming. (reference)

Releases

No releases published

Packages

No packages published