Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @ceramicnetwork/cli

Ceramic CLI

A command line interface that allows you to interact with the Ceramic protocol.

Getting started

Installation

To install the ceramic cli globally you can run:

$ npm install -g @ceramicnetwork/cli

Usage

To get an overview of the available commands run:

$ ceramic -h

To start an instance of the Ceramic daemon, make sure you have ipfs running locally and execute:

$ ceramic daemon

Development

Not yet implemented commands

ceramic user did

Show the DID of the user.

ceramic user sign <payload>

Ask the user to sign a given payload.

ceramic user encrypt <payload>

Ask the user to encrypt a given payload.

ceramic user decrypt <JWE | CWE>

Ask the user to decrypt a given JWE or CWE.

Contributing

We are happy to accept small and large contributions. Make sure to check out the Ceramic specifications for details of how the protocol works.

License

Index

References

CeramicCliUtils

Re-exports CeramicCliUtils

Variables

Const DEFAULT_ANCHOR_SERVICE_URL

DEFAULT_ANCHOR_SERVICE_URL: "https://cas-clay.3boxlabs.com" = "https://cas-clay.3boxlabs.com"

Const DEFAULT_CLI_CONFIG_FILE

DEFAULT_CLI_CONFIG_FILE: "config.json" = "config.json"

Const DEFAULT_CLI_CONFIG_PATH

DEFAULT_CLI_CONFIG_PATH: string = path.join(os.homedir(), '.ceramic')

Const DEFAULT_NETWORK

DEFAULT_NETWORK: "testnet-clay" = "testnet-clay"

Const DEFAULT_PORT

DEFAULT_PORT: 7007 = 7007

Const IPFS_DHT_SERVER_MODE

IPFS_DHT_SERVER_MODE: boolean = process.env.IPFS_DHT_SERVER_MODE === 'true'

Const IPFS_GET_TIMEOUT

IPFS_GET_TIMEOUT: 60000 = 60000

Const config

config: Command = program.command('config')

Const dagJoseFormat

dagJoseFormat: any = legacy(multiformats, dagJose.name)

Const fsPromises

fsPromises: promises = fs.promises

Const pin

pin: Command = program.command('pin')

Const schemas

schemas: Command = program.command('schema')

Functions

buildIpfsConnection

  • buildIpfsConnection(network: string, ipfsEndpoint?: string): Promise<IpfsApi>

Const toApiPath

  • toApiPath(ending: string): string

Object literals

Const BOOTSTRAP

BOOTSTRAP: object

dev-unstable

dev-unstable: string[] = ['/dns4/ipfs-dev.3boxlabs.com/tcp/4012/wss/p2p/Qmc4BVsZbVkuvax6SKgwq5BrcKjzBdwx5dW45cWfLVHabx','/dns4/ipfs-dev.ceramic.network/tcp/4012/wss/p2p/QmStNqcAjwh6s2sxUWr2ZXT3MhRZmqpJ9Dj6fp3gPdHr6E','/dns4/ipfs-dev-internal.3boxlabs.com/tcp/4012/wss/p2p/QmYkpxusRem2iup8ZAfVGYv7iq1ks1yyq2XxQh3z2a8xXq','/dns4/ipfs-dev-cas.3boxlabs.com/tcp/4012/wss/p2p/QmPHLQoWhK4CMPPgxGQxjNYEp1fMB8NPpoLaaR2VDMNbcr']

testnet-clay

testnet-clay: string[] = ['/dns4/ipfs-clay.3boxlabs.com/tcp/4012/wss/p2p/QmWiY3CbNawZjWnHXx3p3DXsg21pZYTj4CRY1iwMkhP8r3','/dns4/ipfs-clay.ceramic.network/tcp/4012/wss/p2p/QmSqeKpCYW89XrHHxtEQEWXmznp6o336jzwvdodbrGeLTk','/dns4/ipfs-clay-internal.3boxlabs.com/tcp/4012/wss/p2p/QmQotCKxiMWt935TyCBFTN23jaivxwrZ3uD58wNxeg5npi','/dns4/ipfs-clay-cas.3boxlabs.com/tcp/4012/wss/p2p/QmbeBTzSccH8xYottaYeyVX8QsKyox1ExfRx7T1iBqRyCd']