Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manicmaniac/sips-js-api
An unofficial documentation of sips's JavaScript API.
https://github.com/manicmaniac/sips-js-api
documentation image-processing macos sips
Last synced: 3 days ago
JSON representation
An unofficial documentation of sips's JavaScript API.
- Host: GitHub
- URL: https://github.com/manicmaniac/sips-js-api
- Owner: manicmaniac
- License: cc0-1.0
- Created: 2021-05-23T18:44:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-08T22:20:07.000Z (about 1 month ago)
- Last Synced: 2024-12-31T05:13:41.518Z (10 days ago)
- Topics: documentation, image-processing, macos, sips
- Homepage: https://manicmaniac.github.io/sips-js-api/
- Size: 376 KB
- Stars: 94
- Watchers: 4
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sips-js-api
An unofficial documentation of `sips`'s JavaScript API.
This documentation is written based on the specification of macOS Monterey.
## What's sips?
If you are using macOS, you already have it in `/usr/bin/sips`.
`sips` is a command-line image processing tool bundled in macOS.
## What's JavaScript interface of sips?
Since Big Sur, `sips` has been shipped with the new feature *JavaScript interface*, that makes `sips` the most powerful ever.
Like ImageMagick, `sips` can compose an arbitrary images as you like, with JavaScript.
However, as far as I know, there's no announcement from Apple about this upgrade and no detailed documentation is provided.
So I investigate the binary of `sips` and expose the hidden APIs I could find.
## Basic usage
#### Hello world
Save the following script as `hello.js`.
```js
console.log('Hello, world!')
```
Then run:
```sh
$ sips -j hello.js
Hello, world!
```
#### Drawing with path
Save the following script as `smile.js`.
```js
const canvas = new Canvas(150, 150)
canvas.beginPath()
canvas.arc(75, 75, 50, 0, Math.PI * 2, true)
canvas.moveTo(110, 75)
canvas.arc(75, 75, 35, 0, Math.PI, false)
canvas.moveTo(65, 65)
canvas.arc(60, 65, 5, 0, Math.PI * 2, true)
canvas.moveTo(95, 65)
canvas.arc(90, 65, 5, 0, Math.PI * 2, true)
canvas.stroke()
const output = new Output(canvas, sips.outputPath)
output.addToQueue()
```
Then run:
```sh
$ sips -j smile.js -o smile.png
```
Output `smile.png` will be:
## License
This document is licensed under CC0 license.
See `LICENSE` for detailed information.