@blocklet/cli

Blocklet Server CLI

This package contains 2 command utilities to manage Blocklet Server and Blocklets

• blocklet: manage blocklets, such as init/dev/bundle/deploy/publish
• blocklet server: manage Blocklet Server instances, such as init/start/stop/export

Getting Started

# install
npm install -g @blocklet/cli

# initialize and start a new node
blocklet server init -f
blocklet server start

Now your Blocklet Server is up and running.

blocklet server command

Powered By
     _             ____  _            _    
    / \   _ __ ___| __ )| | ___   ___| | __
   / _ \ | '__/ __|  _ \| |/ _ \ / __| |/ /
  / ___ \| | | (__| |_) | | (_) | (__|   < 
 /_/   \_\_|  \___|____/|_|\___/ \___|_|\_\
                                           
            Blocklet CLI v1.16.43

Usage: blocklet server [options] [command]

Manage Blocklet Server

Options:
  -V, --version              output the version number
  -c --config [node-config]  Blocklet Server configuration file
  -y --yes                   Automatic yes to prompts (default: false)
  -h, --help                 display help for command

Commands:
  start [options]            Start Blocklet Server
  init [options]             Init Blocklet Server config
  status [options]           Show Blocklet Server and blocklet status
  logs                       Show Blocklet Server and blocklet log files
  stop [options]             Stop Blocklet Server and blocklets
  rescue [options]           Start all blocklets in current running server
  info [options]             Get environment information for debugging and
                             issue reporting
  cleanup [options]          Do some server level cleanup work
  upgrade                    Self-Upgrade Blocklet Server
  help [command]             display help for command

None of the above command seems help? Consider command line utility blocklet.

blocklet command

Usage: blocklet [options] [command]

Options:
  -V, --version                     output the version number
  -y --yes                          Automatic yes to prompts (default: false)
  -h, --help                        display help for command

Commands:
  bundle [options]                  Bundle a blocklet that can run in Blocklet
                                    Server
  deploy [options] <folder>         Deploy blocklet from local directory to
                                    Blocklet Server
  dev [options]                     Develop blocklet from current directory
  test                              Setup blocklet test environment
  init [options]                    Create an empty blocklet project
  meta                              Print blocklet meta from a directory
  version [options] [newVersion]    Bump blocklet version and persist to disk
  upload [options] [metafile]       Upload the blocklet to blocklet store
  exec [options] <script>           Execute script in blocklet running context
  debug [options] <value>           Setting debug environment for blocklet
  connect [options] <store-url>     Connect to blocklet store. This command
                                    will set store configuration by "blocklet
                                    config"
  create [options] [name]           Bootstrap a brand new blocklet from various
                                    starter templates within minutes
  component [options] [command...]  Execute the Component Studio CLI commands
  add [options] <component>         Add component to blocklet.yml
  remove <component>                Remove component from blocklet.yml
  cleanup [options]                 Do some blocklet level cleanup work
  document                          Manage DID document for the blocklet or the
                                    Blocklet Server
  config [options]                  Manage the configuration for Blocklet CLI,
                                    use blocklet config help to see detail
  server [options]                  Manage Blocklet Server
  help [command]                    display help for command

Documentation

https://developer.blocklet.io/docs