Setting Up Ceramic CLI

Note - Follow 2c - Installation Using Javascript Package Managers.

To interact with our API, you'll need to set up Ceramic. This method allows you to install and configure Ceramic using npm or yarn, with more hands-on steps. If you’ve used the Wheel installation, you can skip this section.

Install and start the ceramic-one binary ceramic-one is an extension of Ceramic that simplifies interaction with Ceramic protocols. To install ceramic-one:

Install the component using Homebrew:

brew install ceramicnetwork/tap/ceramic-one

Start the ceramic-one using the following command:

ceramic-one daemon

* note

By default, the command above will spin off a node which connects to a testnet-clay network. You can change this behaviour by providing a --network flag and specifying a network of your choice. For example:

ceramic-one daemon --network testnet-clay

Install Ceramic

ComposeDB runs on Ceramic, so you will need to run a Ceramic node. To get started, we recommend running a local Ceramic node. If you're interested in running the production node, you can follow one of the guides here.

Ceramic CLI provides a set of commands that make it easier to run and manage Ceramic nodes. Start by installing the Ceramic CLI:

npm install --location=global @ceramicnetwork/cli

Install ComposeDB & DevTools

ComposeDB provides two additional libraries that support development:

@composedb/devtools containing utilities related to managing composites
@composedb/devtools-node which contains utilities for interacting with the local file system and starting a local HTTP server.

To install the development packages, run:

npm install -D @composedb/devtools @composedb/devtools-node

Run a Ceramic node

You can check that everything was installed correctly by spinning up a Ceramic node. Running the command below will start the Ceramic node in local mode and connect to Clay testnet. Indexing is a key component of ComposeDB, which syncs data across nodes. Enable indexing by toggling:

npx @ceramicnetwork/cli daemon

You should see the following output in your terminal. This means you have successfully started a local node and connected to Clay testnet 🚀

IMPORTANT: Ceramic API running on 0.0.0.0:7007

Resources:

Ceramic docs - Quickstart

PreviousInstalling & Using Ceramic NextGenerate Developer Account

Last updated 1 year ago