https://github.com/gebeto/scriptables
Scriptable Development Environment for VSCode
https://github.com/gebeto/scriptables
scriptable scriptable-app vscode
Last synced: 9 months ago
JSON representation
Scriptable Development Environment for VSCode
- Host: GitHub
- URL: https://github.com/gebeto/scriptables
- Owner: gebeto
- License: mit
- Created: 2021-05-11T10:19:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T15:04:26.000Z (over 1 year ago)
- Last Synced: 2025-05-07T22:06:28.247Z (9 months ago)
- Topics: scriptable, scriptable-app, vscode
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 114
- Watchers: 5
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Scriptable Development Environment
This project includes
- Scriptable types generated from documentation page
- **RUN SCRIPT** hotkey: ⌘ + SHIFT + B, it will run current script in Scriptable
> Script file name should not contain spaces
- Folder with all your Scriptable apps
## Getting started
How to start to develop scriptable apps with VSCode:
1. Download [Scriptable for MacOS](https://web.archive.org/web/20220721061634/https://scriptable.app/mac-beta/Scriptable.zip) (via Internet Archive Wayback Machine)
2. Enable iCloud sync for Scriptable
3. Download [VSCode](https://code.visualstudio.com/)
4. Clone this repository
```sh
git clone https://github.com/gebeto/scriptables
```
5. Run command to initialize your sources folder link
```sh
./scriptable.sh init
```
6. Done! Open VSCode in the repo(`code .`) and start to build your apps fast and easy!
> Folder `sources` is your scriptable folder link, you can edit files there and it will be updated in scriptable app.
## Initialize your local env
Tou can use BASH script or [VSCode extension](https://marketplace.visualstudio.com/items?itemName=gebeto.vscode-scriptable) for it
```sh
$ ./scriptable.sh init
```
## Import your script for git integration
> IMPORTANT: Script name should not contain any **spaces**, because RUN hotkey will now working
```sh
$ ./scriptable.sh import ScriptName
# or
$ ./scriptable.sh import Script-Name
# or
$ ./scriptable.sh import Script_Name
```
## Relative projects
- [https://github.com/gebeto/scriptable-vscode](https://github.com/gebeto/scriptable-vscode)
> plugin will replace `scriptable.sh` when it will done(work in progress).
- [https://github.com/schl3ck/ios-scriptable-types](https://github.com/schl3ck/ios-scriptable-types)
> Scriptable Typescript typings
## ERRORS
If scriptable typing are not loaded for you, need to add `///` on top of the your script (like shown below).
Where **path** is a relative path to the `index.d.ts` file.
```diff
// Variables used by Scriptable.
// These must be at the very top of the file. Do not edit.
// icon-color: green; icon-glyph: magic;
+ ///
...
```
## Thanks
- [schl3ck](https://github.com/schl3ck) for Scriptable types definition: [ios-scriptable-types](https://github.com/schl3ck/ios-scriptable-types)