near CLI is your human-friendly companion that helps to interact with NEAR Protocol from command line.
Just run near and let it guide you through!
Visit Releases page to see the latest updates.
Install prebuilt binaries via shell script (macOS, Linux, WSL)
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/near/near-cli-rs/releases/latest/download/near-cli-rs-installer.sh | shInstall prebuilt binaries via powershell script (Windows)
irm https://github.com/near/near-cli-rs/releases/latest/download/near-cli-rs-installer.ps1 | iexRun prebuilt binaries with npx (Node.js)
npx near-cli-rsInstall prebuilt binaries into your npm project (Node.js)
npm install near-cli-rsCompile and install from the source code (Cargo)
Install it with cargo, just make sure you have Rust installed on your computer.
cargo install near-cli-rsor, install the most recent version from git repository:
$ cargo install --git https://github.com/near/near-cli-rsInstall on CI (GitHub Actions)
It is often desirable to use near CLI from CI to automate some actions, so here is an example of how you can make a function call during CI:
name: Release
on:
push:
branches: [main]
jobs:
deploy-widgets:
runs-on: ubuntu-latest
name: Make a function call on mainnet
env:
NEAR_NETWORK_CONNECTION: mainnet
NEAR_CONTRACT_ACCOUNT_ID: ${{ vars.NEAR_CONTRACT_ACCOUNT_ID }}
NEAR_SIGNER_ACCOUNT_ID: ${{ vars.NEAR_SIGNER_ACCOUNT_ID }}
NEAR_SIGNER_ACCOUNT_PUBLIC_KEY: ${{ vars.NEAR_SIGNER_ACCOUNT_PUBLIC_KEY }}
NEAR_SIGNER_ACCOUNT_PRIVATE_KEY: ${{ secrets.NEAR_SIGNER_ACCOUNT_PRIVATE_KEY }}
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Install near CLI
run: |
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/near/near-cli-rs/releases/download/v0.7.4/near-cli-rs-installer.sh | sh
- name: Call some function
run: |
near contract call-function as-transaction "$NEAR_CONTRACT_ACCOUNT_ID" 'function_name_here' json-args '{}' prepaid-gas '100 TeraGas' attached-deposit '0 NEAR' sign-as "$NEAR_SIGNER_ACCOUNT_ID" network-config "$NEAR_NETWORK_CONNECTION" sign-with-plaintext-private-key --signer-public-key "$NEAR_SIGNER_ACCOUNT_PUBLIC_KEY" --signer-private-key "$NEAR_SIGNER_ACCOUNT_PRIVATE_KEY" sendYou will need to configure GitHub Actions Secrets and Variables and once it is ready, this CI will only take a couple of seconds to complete!
See how it is used by DevHub.
Once installed, you just run it with near command:
$ near
? What are you up to? (select one of the options with the up-down arrows on your keyboard and press Enter)
> account - Manage accounts
tokens - Manage token assets such as NEAR, FT, NFT
staking - Manage staking: view, add and withdraw stake
contract - Manage smart-contracts: deploy code, call functions
transaction - Operate transactions
config - Manage connections in a configuration file (config.toml)
extension - Manage near CLI and extensions
[↑↓ to move, enter to select, type to filter]The CLI interactively guides you through some pretty complex topics, helping you make informed decisions along the way.