Skip to content

CLI API

This page describes CLI commands for interacting with Ceramic.

Requirements

You should have already installed the CLI.

Write APIs

Create a stream

Use the create command to create a new stream. In the example below we create a stream that uses the TileDocument StreamType. Note that TileDocument is the only StreamType that can currently be created by the Ceramic CLI.

$ ceramic create tile --content '{ "Foo": "Bar" }'

The first line of your output will be the StreamID of your stream. Below the StreamID, you will see it's content.

Create options:

Run ceramic create -h to see all available create options. Some common options:

  • --content: set the content of the stream
  • --controllers: set the controller of the stream
  • --schema: set the schema of the TileDocument

Update a stream

Use the update command to update a stream. You will need to provide a StreamID. Your DID must be the controller of the stream in order to update it. Note that TileDocument is the only StreamType that can currently be updated by the CLI.

$ ceramic update kjzl6cwe1jw147ww5d8pswh1hjh686mut8v1br10dar8l9a3n1wf8z38l0bg8qa --content '{
    "Foo": "Baz"
  }'

Update options:

Run ceramic update -h to see all available update options. Some common options:

  • --content: update the content of the stream
  • --controllers: update the controller of the stream
  • --schema: update the schema of the TileDocument

Query APIs

Query a stream's current state

Use the show command to query the current state of a stream. You will need to provide a StreamID.

$ ceramic show kjzl6cwe1jw147ww5d8pswh1hjh686mut8v1br10dar8l9a3n1wf8z38l0bg8qa

Query a stream's entire state

Use the state command to query the entire state of a stream. You will need to provide a StreamID.

$ ceramic state kjzl6cwe1jw147ww5d8pswh1hjh686mut8v1br10dar8l9a3n1wf8z38l0bg8qa

Next steps

If you haven't already, try putting these CLI commands to use in the Quick Start guide.