Skip to content

create a cli package for the core-sdk #1015

@levalleux-ludo

Description

@levalleux-ludo
  • a cli package should allow any user to realize any core-sdk method in command-line interface
  • the cli package will be published as an npm package @bosonprotocol/cli
  • the cli package should be a workspace of the current mono-repo. Build and publish should be synchronized with build and publish of the core-sdk workspace/package
  • the end-user will be able to call the cli with a command like "npx @bosonprotocol/cli@latest [command] [arguments]"
  • for each command, most of the arguments can be passed either in the command-line or as env var in a local .env file
  • some of commands' arguments are mandatory, while other are optional
  • there are some arguments that are common to every command, for instance "configId" which identify the environment and chain the core-sdk should be initialized
  • some commands does not require a wallet private key, as they don't imply submitting a transaction on-chain. Some other commands require a private key as they imply submitting a transaction or signing a message
  • most of the cli commands already exist in the repository as independent scripts (see ./scripts folder). They will be replaced with equivalent commands in the CLI. The current scripts should be used as examples of the commands to implement in the cli.
  • each command should generate its own documentation page that the end-user can read when typing npx @bosonprotocol/cli@latest help [command]"

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions