@glazed/cli
v0.2.2
Published
Glaze CLI
Downloads
2
Readme
Glaze CLI
Documentation
Installation
npm install -g @glazed/cli
Usage
glaze COMMAND
glaze config:get KEY
glaze config:reset KEY
glaze config:set KEY VALUE
glaze config:show
glaze did:create
glaze did:get MODEL ALIAS
glaze did:inspect
glaze did:merge MODEL ALIAS CONTENTS
glaze did:set MODEL ALIAS CONTENTS
glaze did:sign CONTENTS
glaze did:verify JWS
glaze help [COMMAND]
glaze model:add NAME TYPE ALIAS STREAM
glaze model:create NAME
glaze model:delete NAME
glaze model:deploy NAME [OUTPUT]
glaze model:export NAME [OUTPUT]
glaze model:import LOCALNAME IMPORTNAME
glaze model:inspect NAME
glaze model:list
glaze pin:add STREAMID
glaze pin:ls [STREAMID]
glaze pin:rm STREAMID
glaze stream:commits STREAMID
glaze stream:state STREAMID
glaze tile:create CONTENT
glaze tile:deterministic METADATA
glaze tile:content STREAMID
glaze tile:update STREAMID CONTENT
glaze tile:watch 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
License
Apache-2.0 OR MIT