open-index/open-npm huggingface dataset:
npm package: @flowformer/cli
Description: Flowformer app developer CLI
Author: Flowformer
Latest version: 0.1.0-alpha.10

# @flowformer/cli

The Flowformer CLI is a command-line interface for building and deploying Flowformer apps.

## Installation

```bash
npm install -g @flowformer/cli
```

## Usage

```bash
flowformer --help
```

## Commands

### `flowformer dev`

Start the development server and watches the `.flowform` schema file for changes.

### `flowformer deploy`

Build the app and deploy it to the Flowformer platform.
npm package: @flowformer/create-app
Description: Flowformer app generator
Author: Flowformer
Latest version: 0.1.0-alpha.7

# @flowformer/create-app

The Flowformer Create App is a command-line interface for creating new Flowformer apps.

## Usage

```bash
npx @flowformer/create-app
```

The command will prompt you to enter the App ID and Sandbox ID. The App ID is the unique identifier for your app, and the Sandbox ID is the unique identifier for the environment you are deploying to.

## Templates

Currently, the Flowformer Create App only supports the React TypeScript template. More templates will be added in the future.
npm package: @flowframe/node-previewify
Description: The official Previewify node.js SDK
Author: Lars Klopstra
Latest version: 0.1.0

# Previewify for Node.js

This is the official [Previewify](https://previewify.app) client for Node.js.

## Installation

You can install the package via NPM:

```bash
npm install @flowframe/node-previewify
```

## Usage

### Creating an instance

```js
const { Previewify } = require('@flowframe/node-previewify')

const previewify = new Previewify({ apiToken: '<YOUR_API_TOKEN>' })
```

### Methods

```js
// List sites
previewify
    .listSites()
    .then(response => response.data)

// Show site
let siteId = 1

previewify
    .showSite(siteId)
    .then(response => response.data)

// Show site's templates
let siteId = 1

previewify
    .listSiteTemplates(siteId)
    .then(response => response.data)

// Generate a direct image URL (useful for downloading and storing images yourself)
let siteId = 1
let templateId = 1
let fields = {
    'previewify:title': 'Hello from Node.js!',
    'previewify:subtitle': 'This is an example...',
}

previewify
    .downloadImage({
        siteId,
        templateId,
        fields,
    })
    .then(response => response.data)
```

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

-   [Lars Klopstra](https://github.com/flowframe)
-   [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.