joystream/cli/README.md

joystream-cli

Command Line Interface for Joystream community and governance activities

• Usage

• Commands

  Usage

  $ npm install -g joystream-cli
  $ joystream-cli COMMAND
  running command...
  $ joystream-cli (-v|--version|version)
  joystream-cli/0.0.0 linux-x64 node-v13.12.0
  $ joystream-cli --help [COMMAND]
  USAGE
  $ joystream-cli COMMAND
  ...
  

  Commands

• joystream-cli account:choose

• joystream-cli account:create NAME

• joystream-cli account:current

• joystream-cli account:export PATH

• joystream-cli account:forget

• joystream-cli account:import BACKUPFILEPATH

• joystream-cli account:transferTokens RECIPIENT AMOUNT

• joystream-cli council:info

• joystream-cli help [COMMAND]

joystream-cli account:choose

Choose default account to use in the CLI

USAGE
  $ joystream-cli account:choose

See code: src/commands/account/choose.ts

joystream-cli account:create NAME

Create new account

USAGE
  $ joystream-cli account:create NAME

ARGUMENTS
  NAME  Account name

See code: src/commands/account/create.ts

joystream-cli account:current

Display information about currently choosen default account

USAGE
  $ joystream-cli account:current

ALIASES
  $ joystream-cli account:info
  $ joystream-cli account:default

See code: src/commands/account/current.ts

joystream-cli account:export PATH

Export account(s) to given location

USAGE
  $ joystream-cli account:export PATH

ARGUMENTS
  PATH  Path where the exported files should be placed

OPTIONS
  -a, --all  If provided, exports all existing accounts into "exported_accounts" folder inside given path

See code: src/commands/account/export.ts

joystream-cli account:forget

Forget (remove) account from the list of available accounts

USAGE
  $ joystream-cli account:forget

See code: src/commands/account/forget.ts

joystream-cli account:import BACKUPFILEPATH

Import account using JSON backup file

USAGE
  $ joystream-cli account:import BACKUPFILEPATH

ARGUMENTS
  BACKUPFILEPATH  Path to account backup JSON file

See code: src/commands/account/import.ts

joystream-cli account:transferTokens RECIPIENT AMOUNT

Transfer tokens from currently choosen account

USAGE
  $ joystream-cli account:transferTokens RECIPIENT AMOUNT

ARGUMENTS
  RECIPIENT  Address of the transfer recipient
  AMOUNT     Amount of tokens to transfer

See code: src/commands/account/transferTokens.ts

joystream-cli council:info

Get current council and council elections information

USAGE
  $ joystream-cli council:info

See code: src/commands/council/info.ts

joystream-cli help [COMMAND]

display help for joystream-cli

USAGE
  $ joystream-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help