Getting Started

The Log Store CLI is a command-line tool to mint new LSAN Tokens and manage a staked balance to fund queries and data storage on the Log Store Network.

---

It is built using Typescript & Node.js and allows users to interact with the network via a set of commands.

Installing the CLI

The Log Store Client can be installed using npm, pnpm or yarn. Depending on your unique setup and configuration, you may need to use the sudo command.

npm i -g @logsn/cli

Usage

The command logstore help returns a list of all commands and option flags.

Usage: Log Store CLI [options] [command]

Query and Store on the Log Store Network.

Options:
  -V, --version            output the version number
  -h, --host <string>      Polygon/EVM Node RPC Endpoint
  -w, --wallet <string>    Wallet private key
  -c, --config <string>    Path to configuration file. Default to ~/.logstore-cli/default.json
  -d, --debug              Show debug logs
  --help                   display help for command

Commands:
  version                  Print runtime and protocol version
  init [options]           Creates a configuration file with default parameters
  balance [options]        View the LSAN token balance in your wallet, and available storage to use.
  mint [options] <amount>  Mint LSAN tokens for the Log Store Network
  query                    Manage your Log Store Queries
  store                    Manage your Log Stores
  create-stream <name>     Create Streamr stream to start storing data transported over the stream.
  help [command]           display help for command