near-cli

NEAR CLI (command line interface)

NEAR CLI is a Node.js application that relies on near-api-js to generate secure keys, connect to the NEAR platform and send transactions to the network on your behalf.

note that Node.js version 10+ is required to run NEAR CLI

Installation

npm install -g near-cli

Usage

In command line, from the directory with your project:

near <command>

Commands

For account:

  near login                                       # logging in through NEAR protocol wallet
  near create-account <accountId>                  # create a developer account with --masterAccount (required), publicKey and initialBalance
  near state <accountId>                           # view account state
  near keys <accountId>                            # view account public keys
  near send <sender> <receiver> <amount>           # send tokens to given receiver
  near stake <accountId> <stakingKey> <amount>     # create staking transaction (stakingKey is base58 encoded)
  near delete <accountId> <beneficiaryId>          # delete an account and transfer funds to beneficiary account
  near delete-key [accessKey]                      # delete access key

For smart contract:

  near deploy [accountId] [wasmFile] [initFunction] [initArgs] [initGas] [initDeposit]  # deploy your smart contract
  near dev-deploy [wasmFile]                       # deploy your smart contract using temporary account (TestNet only)
  near call <contractName> <methodName> [args]     # schedule smart contract call which can modify state
  near view <contractName> <methodName> [args]     # make smart contract call which can view state
  near clean                                       # clean the smart contract build locally (remove ./out )

For transactions:

  near tx-status <hash>                            # lookup transaction status by hash

For validators:

  near validators <epoch>                          # lookup validating nodes by epoch(or "current", "next")
  near proposals                                   # lookup current proposals

REPL:

near repl

Launch interactive Node.js shell with NEAR connection available to use. The repl's initial context contains nearAPI, nearand account if an accountId cli argument is provided. To load a script into the repl use .load script.js.

Usage example:

near repl --acountId bob
> console.log(account)
> .load script.js

Misc:

  near repl                                        # launch interactive Node.js shell with NEAR connection available to use
  near generate-key <account-id>                   # generate key locally (Note: this does not create another access key automatically)

Options

Option	Description	Type	Default
--help	Show help	[boolean]
--version	Show version number	[boolean]
--nodeUrl	NEAR node URL	[string]	"http://localhost:3030"
--networkId	NEAR network ID for different keys by network	[string]	"default"
--helperUrl	NEAR contract helper URL	[string]
--keyPath	Path to master account key	[string]
--accountId	Unique identifier for the account	[string] [required]
--masterAccount	Account used to create requested account.	[string] [required]
--publicKey	Public key to initialize the account with	[string] [required]
--initialBalance	Number of tokens to transfer to newly account	[string] [required]

License

This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE and LICENSE-APACHE for details.