Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 1.33 KB

README.md

File metadata and controls

81 lines (54 loc) · 1.33 KB

@cere-ddc-sdk/cli

DDC CLI provides a flexible set of commands for developers to help setting up a DDC account, upload/download files and more.

System requirements

  • NodeJS >= 18.0.0

Installation

Global installation:

npm install -g @cere-ddc-sdk/cli

As a project dependency

npm install --save-dev @cere-ddc-sdk/cli

Running with NPX will auto-install the package

npx @cere-ddc-sdk/cli [command] [options]

Usage

All interactions with DDC CLI are of the form

npx @cere-ddc-sdk/cli [command] [options]

or using named binary

cere-ddc [command] [options]

Help

To display basic commands and arguments -

npx @cere-ddc-sdk/cli --help

Example

Upload a file to DDC

npx @cere-ddc-sdk/cli upload ./image.jpg network=testnet --signer="seed phrase" --bucketId=123

Configuration

It is possible to provide configuration file instead of adding all options to a command line

npx @cere-ddc-sdk/cli upload ./image.jpg --config ./ddc.config.json

The configuration file example

{
    "network": "testnet",
    "signer": "seed phrase",
    "signerType": "sr25519",
    "clusterId": "0x...",
}

Examples

License

Licensed under the Apache License