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: src/commands/bootstrap.ts

idx config:get KEY

get a config value

USAGE
  $ idx config:get KEY

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

See code: src/commands/config/get.ts

idx config:reset KEY

reset a config value

USAGE
  $ idx config:reset KEY

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

See code: src/commands/config/reset.ts

idx config:set KEY VALUE

set a config value

USAGE
  $ idx config:set KEY VALUE

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

See code: src/commands/config/set.ts

idx config:show

show the full config

USAGE
  $ idx config:show

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

See code: src/commands/config/show.ts

idx definition:check ID

check if a document is a valid definition

USAGE
  $ idx definition:check ID

ARGUMENTS
  ID  document ID to check

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

See code: src/commands/definition/check.ts

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: src/commands/definition/create.ts

idx definition:info ID

displays information about a definition

USAGE
  $ idx definition:info ID

ARGUMENTS
  ID  document ID or alias of the definition

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

See code: src/commands/definition/info.ts

idx definition:schema ID

displays the schema for a definition contents

USAGE
  $ idx definition:schema ID

ARGUMENTS
  ID  document ID or alias of the definition

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

See code: src/commands/definition/schema.ts

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: src/commands/did/create.ts

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: src/commands/did/delete.ts

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: src/commands/did/label.ts

idx did:list

list the DIDs stored locally

USAGE
  $ idx did:list

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

See code: src/commands/did/list.ts

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: src/commands/did/sign.ts

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: src/commands/did/verify.ts

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: src/commands/index/get.ts

idx index:inspect DID

inspect the contents of an IDX document

USAGE
  $ idx index:inspect DID

ARGUMENTS
  DID  DID or label

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

See code: src/commands/index/inspect.ts

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: src/commands/index/merge.ts

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: src/commands/index/set.ts

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: src/commands/schema/publish.ts

idx tile:create DID CONTENTS

create a new tile document

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    DocID of the schema validating the contents

See code: src/commands/tile/create.ts

idx tile:get ID

get the contents of a tile document

USAGE
  $ idx tile:get ID

ARGUMENTS
  ID  Document ID

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

See code: src/commands/tile/get.ts

idx tile:merge DID ID CONTENTS

merge the contents of a tile document

USAGE
  $ idx tile:merge 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: src/commands/tile/merge.ts

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: src/commands/tile/set.ts

License

Apache-2.0 OR MIT