# @glazed/cli

> Glaze CLI

Latest version **0.2.2** (published 2022-04-28) · (Apache-2.0 OR MIT) license · 0 weekly downloads

## Install

```sh
npm install @glazed/cli
pnpm add @glazed/cli
yarn add @glazed/cli
bun add @glazed/cli
```

Provides the command `glaze`.

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2022-04-28 |
| First published | 2021-08-13 |
| Weekly downloads | 0 |
| License | (Apache-2.0 OR MIT) |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14.14 |
| Dependencies | 24 |
| Unpacked size | 66.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 124 |
| Author | 3Box Labs |
| Maintainers | paul_lecam |
| Keywords | ceramic, glaze, cli |

## Links

- npm: https://www.npmjs.com/package/@glazed/cli
- Repository: https://github.com/ceramicstudio/js-glaze
- Homepage: https://github.com/ceramicstudio/js-glaze#readme
- Issues: https://github.com/ceramicstudio/js-glaze/issues
- npm.io page: https://npm.io/package/@glazed/cli

## Dependencies (24)

- [ora](https://npm.io/package/ora.md) ^6.1.0
- [conf](https://npm.io/package/conf.md) ^10.1.2
- [dids](https://npm.io/package/dids.md) ^3.0.0
- [chalk](https://npm.io/package/chalk.md) ^5.0.0
- [listr](https://npm.io/package/listr.md) ^0.14.3
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.1
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.4
- [env-paths](https://npm.io/package/env-paths.md) ^3.0.0
- [cli-table3](https://npm.io/package/cli-table3.md) ^0.6.0
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^1.7.0
- [uint8arrays](https://npm.io/package/uint8arrays.md) ^3.0.0
- [did-resolver](https://npm.io/package/did-resolver.md) ^3.2.0
- [@glazed/devtools](https://npm.io/package/@glazed/devtools.md) ^0.2.0
- [key-did-resolver](https://npm.io/package/key-did-resolver.md) ^2.0.0
- [@glazed/datamodel](https://npm.io/package/@glazed/datamodel.md) ^0.3.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5.1.11
- [@glazed/did-datastore](https://npm.io/package/@glazed/did-datastore.md) ^0.3.0
- [@oclif/plugin-version](https://npm.io/package/@oclif/plugin-version.md) ^1.0.4
- [listr-update-renderer](https://npm.io/package/listr-update-renderer.md) ^0.5.0
- [@ceramicnetwork/streamid](https://npm.io/package/@ceramicnetwork/streamid.md) ^2.0.0
- [key-did-provider-ed25519](https://npm.io/package/key-did-provider-ed25519.md) ^2.0.0
- [@ceramicnetwork/http-client](https://npm.io/package/@ceramicnetwork/http-client.md) ^2.0.0
- [@ceramicnetwork/stream-tile](https://npm.io/package/@ceramicnetwork/stream-tile.md) ^2.0.0
- [@ceramicnetwork/3id-did-resolver](https://npm.io/package/@ceramicnetwork/3id-did-resolver.md) ^2.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.2.2 (latest) — 2022-04-28
- 0.2.0-rc.1 (next) — 2022-04-19
- 0.2.1 — 2022-04-26
- 0.2.0 — 2022-04-19
- 0.2.0-rc.0 — 2022-04-04
- 0.1.1 — 2021-08-26
- 0.1.0 — 2021-08-13

## README

# Glaze CLI

## [Documentation](https://developers.ceramic.network/tools/glaze/development/#cli)

## Installation

```sh
npm install -g @glazed/cli
```

## Usage

```sh
glaze COMMAND
```

<!-- commands -->

- [`glaze config:get KEY`](#glaze-configget-key)
- [`glaze config:reset KEY`](#glaze-configreset-key)
- [`glaze config:set KEY VALUE`](#glaze-configset-key-value)
- [`glaze config:show`](#glaze-configshow)
- [`glaze did:create`](#glaze-didcreate)
- [`glaze did:get MODEL ALIAS`](#glaze-didget-model-alias)
- [`glaze did:inspect`](#glaze-didinspect)
- [`glaze did:merge MODEL ALIAS CONTENTS`](#glaze-didmerge-model-alias-contents)
- [`glaze did:set MODEL ALIAS CONTENTS`](#glaze-didset-model-alias-contents)
- [`glaze did:sign CONTENTS`](#glaze-didsign-contents)
- [`glaze did:verify JWS`](#glaze-didverify-jws)
- [`glaze help [COMMAND]`](#glaze-help-command)
- [`glaze model:add NAME TYPE ALIAS STREAM`](#glaze-modeladd-name-type-alias-stream)
- [`glaze model:create NAME`](#glaze-modelcreate-name)
- [`glaze model:delete NAME`](#glaze-modeldelete-name)
- [`glaze model:deploy NAME [OUTPUT]`](#glaze-modeldeploy-name-output)
- [`glaze model:export NAME [OUTPUT]`](#glaze-modelexport-name-output)
- [`glaze model:import LOCALNAME IMPORTNAME`](#glaze-modelimport-localname-importname)
- [`glaze model:inspect NAME`](#glaze-modelinspect-name)
- [`glaze model:list`](#glaze-modellist)
- [`glaze pin:add STREAMID`](#glaze-pinadd-streamid)
- [`glaze pin:ls [STREAMID]`](#glaze-pinls-streamid)
- [`glaze pin:rm STREAMID`](#glaze-pinrm-streamid)
- [`glaze stream:commits STREAMID`](#glaze-streamcommits-streamid)
- [`glaze stream:state STREAMID`](#glaze-streamstate-streamid)
- [`glaze tile:create CONTENT`](#glaze-tilecreate-content)
- [`glaze tile:deterministic METADATA`](#glaze-tiledeterministic-metadata)
- [`glaze tile:content STREAMID`](#glaze-tileshow-streamid)
- [`glaze tile:update STREAMID CONTENT`](#glaze-tileupdate-streamid-content)
- [`glaze tile:watch STREAMID`](#glaze-tilewatch-streamid)

### `glaze config:get KEY`

get a config value

```
USAGE
  $ glaze config:get KEY

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze config:reset KEY`

reset a config value

```
USAGE
  $ glaze config:reset KEY

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze config:set KEY VALUE`

set a config value

```
USAGE
  $ glaze config:set KEY VALUE

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze config:show`

show the full config

```
USAGE
  $ glaze config:show

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze did:create`

create a new DID

```
USAGE
  $ glaze did:create

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze did:get MODEL ALIAS`

get the contents of a record in a DID DataStore

```
USAGE
  $ glaze did:get MODEL ALIAS

ARGUMENTS
  MODEL  Model name or path to JSON file
  ALIAS  Definition alias

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -k, --key=key          DID Private Key
  --did=did              DID
```

### `glaze did:inspect`

inspect the contents of a DID DataStore

```
USAGE
  $ glaze did:inspect

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -k, --key=key          DID Private Key
  --did=did              DID
```

### `glaze did:merge MODEL ALIAS CONTENTS`

merge the contents of a record in a DID DataStore

```
USAGE
  $ glaze did:merge MODEL ALIAS CONTENTS

ARGUMENTS
  MODEL     Model name or path to JSON file
  ALIAS     Definition alias
  CONTENTS  String-encoded JSON data

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -k, --key=key          DID Private Key
```

### `glaze did:set MODEL ALIAS CONTENTS`

set the contents of a record in a DID DataStore

```
USAGE
  $ glaze did:set MODEL ALIAS CONTENTS

ARGUMENTS
  MODEL     Model name or path to JSON file
  ALIAS     Definition alias
  CONTENTS  String-encoded JSON data

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -k, --key=key          DID Private Key
```

### `glaze did:sign CONTENTS`

create a JSON Web Signature

```
USAGE
  $ glaze did:sign CONTENTS

ARGUMENTS
  CONTENTS  String-encoded JSON data

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -k, --key=key          DID Private Key
```

### `glaze did:verify JWS`

verify a JSON Web Signature

```
USAGE
  $ glaze did:verify JWS

ARGUMENTS
  JWS  JSON Web Signature

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -k, --key=key          DID Private Key
```

### `glaze help [COMMAND]`

display help for glaze

```
USAGE
  $ glaze help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

### `glaze model:add NAME TYPE ALIAS STREAM`

add a stream to a model

```
USAGE
  $ glaze model:add NAME TYPE ALIAS STREAM

ARGUMENTS
  NAME
  TYPE    (schema|definition|tile)
  ALIAS
  STREAM  Stream reference or string-encoded JSON content

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  --schema=schema        tile schema
```

### `glaze model:create NAME`

create a local model

```
USAGE
  $ glaze model:create NAME

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze model:delete NAME`

delete a local model

```
USAGE
  $ glaze model:delete NAME

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -f, --force            bypass confirmation prompt
```

### `glaze model:deploy NAME [OUTPUT]`

deploy a model

```
USAGE
  $ glaze model:deploy NAME [OUTPUT]

ARGUMENTS
  NAME    local model name or package
  OUTPUT  JSON file to output the deployed model aliases

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze model:export NAME [OUTPUT]`

export a model

```
USAGE
  $ glaze model:export NAME [OUTPUT]

ARGUMENTS
  NAME    local model name or package
  OUTPUT  JSON file to output the model to

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze model:import LOCALNAME IMPORTNAME`

import a model into another one

```
USAGE
  $ glaze model:import LOCALNAME IMPORTNAME

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze model:inspect NAME`

inspect a model

```
USAGE
  $ glaze model:inspect NAME

ARGUMENTS
  NAME  local model name or package

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze model:list`

list local models

```
USAGE
  $ glaze model:list

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze pin:add STREAMID`

pin a stream

```
USAGE
  $ glaze pin:add STREAMID

ARGUMENTS
  STREAMID  ID of stream to be pinned

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze pin:ls [STREAMID]`

list pinned streams

```
USAGE
  $ glaze pin:ls [STREAMID]

ARGUMENTS
  STREAMID  optional stream ID filter

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze pin:rm STREAMID`

unpin a stream

```
USAGE
  $ glaze pin:rm STREAMID

ARGUMENTS
  STREAMID  ID of stream to be unpinned

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze stream:commits STREAMID`

list commits contained within a stream

```
USAGE
  $ glaze stream:commits STREAMID

ARGUMENTS
  STREAMID  ID of the stream

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze stream:state STREAMID`

get the state of a Stream

```
USAGE
  $ glaze stream:state STREAMID

ARGUMENTS
  STREAMID  ID of the Stream

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze tile:create`

create a new Tile stream

```
USAGE
  $ glaze tile:create

OPTIONS
  -b, --content=content    stream contents (JSON encoded as string)
  -c, --ceramic=ceramic    Ceramic API URL
  -k, --key=key            DID Private Key
  -m, --metadata=metadata  stream metadata
```

### `glaze tile:deterministic METADATA`

load a deterministic Tile stream, or create it if it doesn't already exist

```
USAGE
  $ glaze tile:deterministic METADATA

ARGUMENTS
  METADATA  stream metadata

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -k, --key=key          DID Private Key
```

### `glaze tile:content STREAMID`

show the contents of a Tile stream

```
USAGE
  $ glaze tile:content STREAMID

ARGUMENTS
  STREAMID  ID of the stream

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
```

### `glaze tile:update STREAMID`

Update a stream

```
USAGE
  $ glaze tile:update STREAMID

ARGUMENTS
  STREAMID  ID of the stream

OPTIONS
  -b, --content=content    new contents for the stream
  -c, --ceramic=ceramic    Ceramic API URL
  -k, --key=key            DID Private Key
  -m, --metadata=metadata  Optional metadata for the stream
```

<!-- commandsstop -->

## License

Apache-2.0 OR MIT

---
_Source: https://npm.io/package/@glazed/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._