README

IDX CLI

Installation

npm install -g @ceramicstudio/idx-cli

Usage

idx COMMAND

idx bootstrap
idx config:get KEY
idx config:reset KEY
idx config:set KEY VALUE
idx config:show
idx definition:check ID
idx definition:create DID
idx definition:info ID
idx definition:schema ID
idx did:create
idx did:delete DID
idx did:label DID [LABEL]
idx did:list
idx did:sign DID CONTENTS
idx did:verify JWS
idx help [COMMAND]
idx index:get DID KEY
idx index:inspect DID
idx index:merge DID KEY CONTENTS
idx index:set DID KEY CONTENTS
idx schema:publish DID SCHEMA
idx tile:create DID CONTENTS
idx tile:get ID
idx tile:merge DID ID CONTENTS
idx tile:set DID ID CONTENTS

`idx bootstrap`

bootstrap IDX on a Ceramic node

USAGE
  $ idx bootstrap

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

See code: lib/commands/bootstrap.js

`idx config:get KEY`

get a config value

USAGE
  $ idx config:get KEY

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

See code: lib/commands/config/get.js

`idx config:reset KEY`

reset a config value

USAGE
  $ idx config:reset KEY

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

See code: lib/commands/config/reset.js

`idx config:set KEY VALUE`

set a config value

USAGE
  $ idx config:set KEY VALUE

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

See code: lib/commands/config/set.js

`idx config:show`

show the full config

USAGE
  $ idx config:show

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

See code: lib/commands/config/show.js

`idx definition:check ID`

check if a stream is a valid definition

USAGE
  $ idx definition:check ID

ARGUMENTS
  ID  stream ID to check

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

See code: lib/commands/definition/check.js

`idx definition:create DID`

create a definition

USAGE
  $ idx definition:create DID

ARGUMENTS
  DID  DID to create the definition with

OPTIONS
  -c, --ceramic=ceramic          Ceramic API URL
  -d, --description=description  (required) description of the definition
  -n, --name=name                (required) name of the definition
  -s, --schema=schema            (required) schema for the definition contents
  -u, --url=url                  documentation URL for the definition

See code: lib/commands/definition/create.js

`idx definition:info ID`

displays information about a definition

USAGE
  $ idx definition:info ID

ARGUMENTS
  ID  stream ID or alias of the definition

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

See code: lib/commands/definition/info.js

`idx definition:schema ID`

displays the schema for a definition contents

USAGE
  $ idx definition:schema ID

ARGUMENTS
  ID  stream ID or alias of the definition

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

See code: lib/commands/definition/schema.js

`idx did:create`

create a new DID

USAGE
  $ idx did:create

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -l, --label=label      label for the DID
  -s, --seed=seed        base16-encoded seed to use for the DID

See code: lib/commands/did/create.js

`idx did:delete DID`

delete a local DID

USAGE
  $ idx did:delete DID

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

See code: lib/commands/did/delete.js

`idx did:label DID [LABEL]`

manage the label for a DID

USAGE
  $ idx did:label DID [LABEL]

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -d, --delete           delete the label

See code: lib/commands/did/label.js

`idx did:list`

list the DIDs stored locally

USAGE
  $ idx did:list

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

See code: lib/commands/did/list.js

`idx did:sign DID CONTENTS`

create a JSON Web Signature

USAGE
  $ idx did:sign DID CONTENTS

ARGUMENTS
  DID       DID or label
  CONTENTS  String-encoded JSON data

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

See code: lib/commands/did/sign.js

`idx did:verify JWS`

verify a JSON Web Signature

USAGE
  $ idx did:verify JWS

ARGUMENTS
  JWS  JSON Web Signature

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

See code: lib/commands/did/verify.js

`idx help [COMMAND]`

display help for idx

USAGE
  $ idx help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`idx index:get DID KEY`

get the contents of a key in IDX

USAGE
  $ idx index:get DID KEY

ARGUMENTS
  DID  DID or label
  KEY

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

See code: lib/commands/index/get.js

`idx index:inspect DID`

inspect the contents of an IDX stream

USAGE
  $ idx index:inspect DID

ARGUMENTS
  DID  DID or label

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

See code: lib/commands/index/inspect.js

`idx index:merge DID KEY CONTENTS`

merge the contents of a key in IDX

USAGE
  $ idx index:merge DID KEY CONTENTS

ARGUMENTS
  DID       DID or label
  KEY
  CONTENTS  String-encoded JSON data

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

See code: lib/commands/index/merge.js

`idx index:set DID KEY CONTENTS`

set the contents of a key in IDX

USAGE
  $ idx index:set DID KEY CONTENTS

ARGUMENTS
  DID       DID or label
  KEY
  CONTENTS  String-encoded JSON data

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

See code: lib/commands/index/set.js

`idx schema:publish DID SCHEMA`

publish a schema

USAGE
  $ idx schema:publish DID SCHEMA

ARGUMENTS
  DID     DID or label
  SCHEMA  String-encoded JSON schema

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

See code: lib/commands/schema/publish.js

`idx tile:create DID CONTENTS`

create a new tile stream

USAGE
  $ idx tile:create DID CONTENTS

ARGUMENTS
  DID       DID or label
  CONTENTS  String-encoded JSON data

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  -s, --schema=schema    StreamID of the schema validating the contents

See code: lib/commands/tile/create.js

`idx tile:get ID`

get the contents of a tile stream

USAGE
  $ idx tile:get ID

ARGUMENTS
  ID  Stream ID

OPTIONS
  -c, --ceramic=ceramic  Ceramic API URL
  --did=did              DID or label

See code: lib/commands/tile/get.js

`idx tile:merge DID ID CONTENTS`

merge the contents of a tile stream

USAGE
  $ idx tile:merge DID ID CONTENTS

ARGUMENTS
  DID       DID or label
  ID        Stream ID
  CONTENTS  String-encoded JSON data

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

See code: lib/commands/tile/merge.js

`idx tile:set DID ID CONTENTS`

set the contents of a tile document

USAGE
  $ idx tile:set DID ID CONTENTS

ARGUMENTS
  DID       DID or label
  ID        Document ID
  CONTENTS  String-encoded JSON data

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

See code: lib/commands/tile/set.js

License

Apache-2.0 OR MIT

@ceramicstudio/idx-clideprecated

Usage no npm install needed!