https://github.com/near/near-cli-rs
near CLI is your human-friendly companion that helps to interact with NEAR Protocol from command line.
https://github.com/near/near-cli-rs
blockchain cli hacktoberfest nearprotocol
Last synced: 2 months ago
JSON representation
near CLI is your human-friendly companion that helps to interact with NEAR Protocol from command line.
- Host: GitHub
- URL: https://github.com/near/near-cli-rs
- Owner: near
- License: apache-2.0
- Created: 2021-03-02T18:37:25.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-04-16T16:30:53.000Z (2 months ago)
- Last Synced: 2026-04-16T16:32:02.690Z (2 months ago)
- Topics: blockchain, cli, hacktoberfest, nearprotocol
- Language: Rust
- Homepage: https://near.cli.rs
- Size: 13.4 MB
- Stars: 140
- Watchers: 6
- Forks: 77
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# NEAR CLI
near CLI is your **human-friendly** companion that helps to interact with [NEAR Protocol](https://near.org) from command line.
Just run `near` and let it guide you through!
## Install
Visit [Releases page](https://github.com/near/near-cli-rs/releases/) to see the latest updates.
Install via Windows Installer (Windows)
https://github.com/user-attachments/assets/607f797b-0412-4741-984b-6b6032d05262
Install via powershell script (Windows)
```sh
irm https://github.com/near/near-cli-rs/releases/latest/download/near-cli-rs-installer.ps1 | iex
```
https://github.com/user-attachments/assets/7d5d090e-4885-4c27-9d0f-045905952071
Install via shell script (macOS, Linux, Windows/WSL)
```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/near/near-cli-rs/releases/latest/download/near-cli-rs-installer.sh | sh
```
Run via npx (Node.js on Windows, Linux, macOS)
```sh
npx near-cli-rs
```
Use in package.json scripts (Node.js on Windows, Linux, macOS)
```sh
npm install near-cli-rs
```
Get a portable version (Windows, Linux, macOS)
https://github.com/user-attachments/assets/4a7e4633-1957-4dc2-a032-827fa9c06c29
Compile and install from the source code (Cargo on Windows, Linux, macOS)
Install it with `cargo`, just make sure you have [Rust](https://rustup.rs) installed on your computer.
> NOTE: On Linux, near-cli-rs is built with Ledger devices support by default, and that requires `libudev-dev` package. On Debian/Ubuntu, install it with `apt install libudev-dev`.
```bash
cargo install near-cli-rs
```
or, install the most recent version from git repository:
```bash
$ cargo install --git https://github.com/near/near-cli-rs
```
Install 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:
```yml
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" send
```
You 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]([https://github.com/near/devgigsboard](https://github.com/NEAR-DevHub/neardevhub-contract/blob/05fb66ac307d84347f29e8e3ab9f429a78cb6513/.github/workflows/release.yml#L30-L41)).
## Run
Once installed, you just run it with `near` command:
```bash
$ 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. Also, you can enable [shell history integration](docs/SHELL_HISTORY_INTEGRATION.md)
## [Read more in English](docs/README.en.md)
- [Usage](docs/README.en.md#usage)
- [Installation](docs/README.en.md#installation)
- [User Guide](docs/README.en.md#user-guide)
- [Config](docs/README.en.md#config)
- [Building](docs/README.en.md#building)
## [Больше информации на русском языке (in Russian)](docs/README.ru.md)
- [Применение](docs/README.ru.md#применение)
- [Установка](docs/README.ru.md#установка)
- [Инструкция](docs/README.ru.md#инструкция)
- [Конфигурационный файл](docs/README.ru.md#конфигурационный-файл)
- [Сборка](docs/README.ru.md#сборка)