Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vpzomtrrfrt/stability-client
DreamStudio Client written in TypeScript
https://github.com/vpzomtrrfrt/stability-client
Last synced: 23 days ago
JSON representation
DreamStudio Client written in TypeScript
- Host: GitHub
- URL: https://github.com/vpzomtrrfrt/stability-client
- Owner: vpzomtrrfrt
- License: mit
- Fork: true (jakiestfu/stability-ts)
- Created: 2022-09-14T17:28:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-02T16:33:21.000Z (about 1 year ago)
- Last Synced: 2024-05-18T06:40:55.125Z (about 1 month ago)
- Language: TypeScript
- Size: 229 KB
- Stars: 36
- Watchers: 3
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-javascript-ai - Stability.ai TS
README
# stability-client
A client library for the Stability AI SDK.
[Requires an API Key for DreamStudio which can be found here.](https://beta.dreamstudio.ai/membership)
## Installation
```sh
# NPM
npm i -g stability-client
# To Update
npm update -g stability-client
# Yarn
yarn global add stability-client
```
## Example
```sh
stability \
-s 150 \ # Steps
-c 15 \ # Cfg Scale
-a k_euler_ancestral \ # Diffusion Method
-S 3465383516 \ # Seed
-o ./examples \ # Output Directory
-n 5 \ # 5 images
"a anime still of an highly detailed night cyberpunk city life, bladerunner style!! detailed shops, neon lights, ray tracing, advertising everywhere, people and robots walking around. art by satoshi kon and studio ghibli, in the style of ghost in the shell, muted colours, hyperrealism, cinematic lighting, lush detail, award winning, wlop, octane render, trending on artstation"
```
### Output
| 
| 
| 
| 
| 
|
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
---
## API
```ts
import { generate } from 'stability-client'
const api = generate({
prompt: 'A Stunning House',
apiKey: process.env.DREAMSTUDIO_API_KEY,
})
api.on('image', ({ buffer, filePath }) => {
console.log('Image', buffer, filePath)
})
api.on('end', (data) => {
console.log('Generating Complete', data)
})
```
Async/Promise API
```ts
import { generateAsync } from 'stability-client'
try {
const { res, images } = await generateAsync({
prompt: 'A Stunning House',
apiKey: process.env.DREAMSTUDIO_API_KEY,
})
console.log(images)
} catch (e) {
// ...
}
```
## Example with a lot of options:
```js
const imgBuffer = Buffer.from(base64ImageRaw, 'base64')
const api = await generate({
prompt: `amazing looking room, Dean Norton style`,
apiKey: process.env.STABLE_DIFFUSION_KEY,
width: 512,
height: 512,
steps: 10,
engine: 'stable-diffusion-512-v2-1',
cfgScale: 10,
noStore: false, // if set to true, it won't save files to outDir after generation.
imagePrompt: {
mime: 'image/png',
content: imgBuffer,
},
samples: 1,
diffusion: 'ddim',
outDir: '/output',
})
api.on('image', async ({ buffer, imagePath }) => {
// upload somewhere probably..
})
api.on('end', (data) => {
console.log('Generating Complete', data)
})
```
## CLI
```sh
Usage: stability [options] [prompt]
Generate an image
Arguments:
prompt The text prompt you want to use
Options:
-V, --version output the version number
-H, --height height of image (default: 512)
-W, --width width of image (default: 512)
-c, --cfg_scale CFG scale factor (default: 7)
-a, --sampler Diffusion Method (choices: "ddim", "plms", "k_euler", "k_euler_ancestral", "k_heun", "k_dpm_2", "k_dpm_2_ancestral", "k_lms", default: "k_lms")
-s, --steps number of steps (default: 50)
-S, --seed random seed to use (default: 1614811539)
-n, --num_samples number of samples to generate (default: 1)
-e, --engine engine to use for inference (default: "stable-diffusion-v1")
--no-store do not write artifacts to disk
-k, --api-key DreamStudio API Key (env: DREAMSTUDIO_API_KEY)
-o, --output-dir directory to store images (defaults to cwd)
-d, --debug Additional logging
-h, --help display help for command
```
## Developing
```
nvm use
yarn
yarn build
npm link
export DREAMSTUDIO_API_KEY=...
stability "A stunning house"
```