{"id":16665231,"url":"https://github.com/Lathryx/Scriptable-Getting-Started-Guide","last_synced_at":"2025-10-30T17:31:16.379Z","repository":{"id":56370745,"uuid":"310132968","full_name":"Lathryx/Scriptable-Getting-Started-Guide","owner":"Lathryx","description":"A getting started guide to the Scriptable mobile app for iOS. ","archived":false,"fork":false,"pushed_at":"2020-11-11T21:50:10.000Z","size":14,"stargazers_count":25,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-13T11:04:15.443Z","etag":null,"topics":["documentation","getting-started","guide","how-to","howto","ios","scriptable-app"],"latest_commit_sha":null,"homepage":"https://scriptable.app","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Lathryx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-04T22:34:27.000Z","updated_at":"2024-10-09T00:24:35.000Z","dependencies_parsed_at":"2022-08-15T17:30:59.639Z","dependency_job_id":null,"html_url":"https://github.com/Lathryx/Scriptable-Getting-Started-Guide","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lathryx%2FScriptable-Getting-Started-Guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lathryx%2FScriptable-Getting-Started-Guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lathryx%2FScriptable-Getting-Started-Guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lathryx%2FScriptable-Getting-Started-Guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Lathryx","download_url":"https://codeload.github.com/Lathryx/Scriptable-Getting-Started-Guide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239011372,"owners_count":19567653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","getting-started","guide","how-to","howto","ios","scriptable-app"],"created_at":"2024-10-12T11:01:56.866Z","updated_at":"2025-10-30T17:31:16.004Z","avatar_url":"https://github.com/Lathryx.png","language":null,"readme":"### What *is* [Scriptable](https://scriptable.app/)? \n![Scriptable Icon](https://www10.lunapic.com/do-not-link-here-use-hosting-instead/160513042337117757?9316193389)  \n\nScriptable 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](https://simonbs.dk/), the creator of various other apps such as [Jayson](https://jayson.app/) and [Data Jar](https://datajar.app/).\n\nScriptable, according to their [official website](https://scriptable.app/), currently consists of the following features: \n\u003e **Plain Javascript** \n\u003e - Supports JavaScript ES6. Scripts are stored as plain JS files on disk.  \n\u003e\n\u003e **Native APIs**\n\u003e - Integrate with the native APIs of iOS directly from JavaScript.  \n\u003e\n\u003e **Siri Shortcuts**\n\u003e - Run scripts from Siri Shortcuts. Present tables, websites, HTML and more in Siri.  \n\u003e\n\u003e **Documentation** \n\u003e - All native APIs that are bridged to JavaScript have documentation which is available offline.  \n\u003e\n\u003e **Share Sheet Extension**\n\u003e - Run a script from a share sheet and process the inputs.  \n\u003e\n\u003e **Files Integration**\n\u003e - Integrated with the file system and Files.app enabling you to perform operations on files.  \n\u003e\n\u003e **Customizable**\n\u003e - The editor can be customized to match your preferences.  \n\u003e\n\u003e **Example scripts**\n\u003e - Comes with several example scripts to get you started.  \n\u003e\n\u003e **x-callback-url**\n\u003e - Communicate with other apps using x-callback-url.  \n\nBy 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. \n\n## Getting Started \nThough Scriptable has its own documentation, found [here](https://docs.scriptable.app/), it could be difficult to get started using their API. This guide will act to help with that. \n\n**This guide assumes the following:** \n- A good understanding of Javascript. \n  - Some good references for Javascript can be found on [w3schools](https://www.w3schools.com/js/js_intro.asp) or [MDN web docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide). Good beginner courses can be found on [Codecademy](https://www.codecademy.com/learn/introduction-to-javascript) or [SoloLearn](https://www.sololearn.com/Course/JavaScript/?ref=app).\n- Access to an iOS device. \n- iOS 14 or later. \n- You have the [Scriptable app](https://apps.apple.com/us/app/scriptable/id1405459188) or [Testflight beta](https://testflight.apple.com/join/uN1vTqxk). \n\nFurther updates, announcements, or assisstance can be found on the unofficial Scriptable [subreddit](https://reddit.com/r/scriptable/) and [Discord server](https://discord.gg/fsguJthT). \n\n\n## Helpful Links of Information  \nBelow is a list of links containing information that may help while you are programming. (reference) \n\u003c!-- This is a list of links that have beneficial info to help you in your code writing experience. --\u003e \n\n- [List of time zones for use in the Date.toLocaleDateString method](https://gist.github.com/rxaviers/8481876). \n","funding_links":[],"categories":["Others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLathryx%2FScriptable-Getting-Started-Guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLathryx%2FScriptable-Getting-Started-Guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLathryx%2FScriptable-Getting-Started-Guide/lists"}