open-index/open-npm huggingface dataset:
npm package: @stately-cloud/cli
Description: Install the `stately` CLI as part of `npm install` or run it via `npx @stately-cloud/cli`. StatelyDB is a document database built on top of DynamoDB with Elastic Schema that allows you to change your data model any time with automatic backwards compatibil
Author: Stately Cloud
Latest version: 0.97.0

# Node.js/npm Stately CLI installer

A simple Node.js installer for the Stately CLI (https://docs.stately.cloud/cli/). This allows
you to depend on Stately CLI from your `package.json` and install it as part of the `npm install` command, so you don't have to worry about installing
it separately.

Add it to your project:

```bash
$ npm install -D @stately-cloud/cli
# or
$ yarn add -D @stately-cloud/cli
# or (see note about PNPM below)
$ pnpm add -D @stately-cloud/cli
```

Or run the CLI directly via npx without installing:

```bash
$ npx @stately-cloud/cli login
```

**A note about PNPM**: As of PNPM v10, [you must add this package to `pnpm-workspace.yml` in the `onlyBuiltDependencies` setting](https://pnpm.io/settings#onlybuiltdependencies) in order for it to be installed, since PNPM skips running `preinstall` scripts from dependencies.

## Purpose

The Stately CLI lets you manage your [Elastic Schema](https://docs.stately.cloud/intro/elastic-schema/) for [StatelyDB](https://docs.stately.cloud/intro/what-is-statelydb/). After installation, the `stately` command will work in npm scripts:

```js
// package.json:

{
  // ...
  "scripts": {
    "generate": "stately schema generate -l ts ./app/schema"
  }
}
```

Or with `npx`:

```bash
$ npx stately schema generate -l ts ./app/schema
```
npm package: @stately-cloud/client
Description: Client for StatelyDB, a document database built on top of DynamoDB with Elastic Schema that allows you to change your data model any time with automatic backwards compatibility.
Author: Stately Cloud
Latest version: 0.37.0

# Stately JavaScript/TypeScript Client

StatelyDB is a document database built on top of DynamoDB. It uses Elastic Schema to allow you to update your data model at any time, with automatic backwards and forwards compatibility.

This client is currently meant for use from NodeJS server applications.

The client library can be installed from NPM:

```
npm install @stately-cloud/client
# or
pnpm install @stately-cloud/client
# or
yarn add @stately-cloud/client
```

[Read our documentation](https://docs.stately.cloud/guides/getting-started/) to get started and learn how to use StatelyDB.
npm package: @stately-cloud/schema
Description: Schema Language for StatelyDB, a document database built on top of DynamoDB with Elastic Schema that allows you to change your data model any time with automatic backwards compatibility.
Author: Stately Cloud
Latest version: 0.34.4

# StatelyDB Schema Language

StatelyDB is a document database built on top of DynamoDB. It uses Elastic Schema to allow you to update your data model at any time, with automatic backwards and forwards compatibility.

This is a TypeScript domain-specific language (DSL) for generating StatelyDB Schemas. You use schemas to define the shape of your data model in StatelyDB, including validation, types, and other database configuration such as key paths and indexes. You can also use migrations to change your data model, automatically preserving backwards and forwards compatibility with existing schema versions. It is meant to be used with the `stately` CLI, e.g. `stately schema put index.ts`.

# How it's used

1. Follow our [Getting Started](https://docs.stately.cloud/guides/getting-started/) guide to install the Stately CLI.
1. Run `stately schema init myschema` to create a new schema in the folder `myschema`.
1. Develop your schema in TypeScript (`.ts`) files. These import from `@stately-cloud/schema` to get types and builder functions.
1. Run `stately schema validate myschema/index.ts` to check your schema.
1. Run `stately schema put --schema-id 12345 --message "an update message" myschema/index.ts` to upload the schema to your store.
1. Run `stately schema generate --language typescript --schema-id 12345 <output-dir>` to generate typed models for your schema.