@masa-finance/masa-cli

Masa CLI

$ masa --help
  __  __                            ____   _       ___ 
 |  \/  |   __ _   ___    __ _     / ___| | |     |_ _|
 | |\/| |  / _` | / __|  / _` |   | |     | |      | | 
 | |  | | | (_| | \__ \ | (_| |   | |___  | |___   | | 
 |_|  |_|  \__,_| |___/  \__,_|    \____| |_____| |___|
                                                       
Usage: masa [command] [subcommand] [arguments] [options]

The Masa CLI

Options:
  -v, --version   output the version number
  -h, --help      display help for command

Commands:
  login                                   Login to the masa infrastructure
  logout                                  Logout from the masa infrastructure
  account                                 Shows information about your account
  identity                                Identity commands
  identity info                           Shows info about all Identities
  identity create <soulname> <duration>   Creates a masa identity with soul name
  identity show [options]                 Shows detail about your masa identity
  identity burn                           Burns your masa identity
  soul-name                               Soul Name Commands
  soul-name info                          Shows info about all Soul Names
  soul-name list [options]                Lists your soul names
  soul-name create <soulname> <duration>  Creates a new soul name
  soul-name burn <soulname>               Burns soul name that you own
  credit-report                           Credit Report Commands
  credit-report info                      Shows info about all Credit Reports
  credit-report list [options]            Lists your Credit Reports
  credit-report create                    Creates a Credit Report
  credit-report burn <Credit Report ID>   Burns a Credit Report 
  settings                                Set config settings
  settings set <key> <value>              Changes setting <key> to <value>
  settings preset <environment>           Changes setting <environment> presets
  help [command]                          display help for command

To get help for a specific command use:

$ masa identity --help

to get help for the identity commands.

Usage / Installation

npm

npm install -g @masa-finance/masa-cli

$ masa --version

CLI: v0.1.0 Contracts: v0.3.0 SDK: v0.9.1
Arweave Endpoint: https://arweave.net:443
RPC Endpoint: https://rpc.ankr.com/eth_goerli
Masa Endpoint: https://dev.middleware.masa.finance/

Yarn

yarn global add @masa-finance/masa-cli

$ masa --version

CLI: v0.1.0 Contracts: v0.3.0 SDK: v0.9.1
Arweave Endpoint: https://arweave.net:443
RPC Endpoint: https://rpc.ankr.com/eth_goerli
Masa Endpoint: https://dev.middleware.masa.finance/

npx

$ npx @masa-finance/masa-cli@latest --version

CLI: v0.1.0 Contracts: v0.3.0 SDK: v0.9.1
Arweave Endpoint: https://arweave.net:443
RPC Endpoint: https://rpc.ankr.com/eth_goerli
Masa Endpoint: https://dev.middleware.masa.finance/

Commands

masa login

Login to the masa infrastructure

masa logout

Logout from the masa infrastructure

masa account

Shows information about your account

masa identity

Identity commands

masa identity info

Shows info about all Identities

masa identity create <soulname> <duration>

Creates a masa identity with soul name

• <soulname> soulname to register
• <duration> period of registration

masa identity show

Shows detail about your masa identity

Options:

• -a, --address [address] Address override

masa identity burn

Burns your masa identity

masa soul-name

Soul Name Commands

masa soul-name info

Shows info about all Soul Names

masa soul-name list

Lists your soul names

Options:

• -a, --address [address] Address override

masa soul-name create <soulname> <duration>

Creates a new soul name

• <soulname> soulname to register
• <duration> period of registration

masa soul-name burn <soulname>

Burns soul name that you own

• <soulname> soulname to burn

masa credit-report

Credit Report Commands

masa credit-report info

Shows info about all Credit Reports

masa credit-report list

Lists your Credit Reports

Options:

• -a, --address [address] Address override

masa credit-report create

Creates a Credit Report

masa credit-report burn <Credit Report ID>

Burns a Credit Report

• <Credit Report ID> ID of the Credit Report to burn

masa settings

Set config settings

masa settings set <key> <value>

Changes setting to

• <key> key to set
• <value> value to set to key

masa settings preset <environment>

Changes setting presets

• <environment> The environment to use as preset

Configuration

All the below fields can be set with:

$ masa settings set <key> <value>

Key	Type	Description	Default Value
cookie	string	Stores cookie value. Don't set this manually unless you know what you do!
api-url	string	The API Endpoint of the Masa Infrastructure for dev, test, beta and production.	"https://dev.middleware.masa.finance/"
environment	string	The environment to use dev, test, beta, production.	"dev"
rpc-url	string	The RPC Endpoint to reach the Blockchain.	"https://rpc.ankr.com/eth_goerli"
network	string	The network name ie. "goerli".	"goerli"
private-key	string	Your private key of the account to use in the cli.	ethers.Wallet.createRandom().privateKey
arweave-host	string	The arweave host to use for loading metadata.	"arweave.net"
arweave-port	number	The arweave port to use for loading metadata.	443
arweave-protocol	string	The arweave protocol to use for loading metadata.	"https"
arweave-logging	boolean	Turn arweave logging on or off.	false