Skip to content

Update cli docs with new args #1102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tituszban wants to merge 1 commit into from
Closed

Update cli docs with new args #1102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 35 additions & 8 deletions docs/tools/near-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,17 +111,22 @@ Copy/pasting can be a bit odd using `WSL`.

Another way for Windows users (not fully tested):

1. Install node.js from https://nodejs.org/en/
2. In cmd.exe run:
```bash
1. Install node.js from https://nodejs.org/en/
2. In cmd.exe run:

```bash
npm install -g near-cli
```

3. Set enviroment variable:

```bash
set NEAR_ENV=YOURNETWORK
```

By deffault cli used Testnet
NOTE: in all comands with '{}' you need to replace spaces to \ in {}
NOTE: in all comands with '{}' you need to replace spaces to \ in {}

---

### Update `near-cli` {#update-near-cli}
Expand Down Expand Up @@ -433,12 +438,12 @@ near generate-key example.testnet --seedPhrase="cow moon right send now cool den

#### 1) add a `full access` key {#1-add-a-full-access-key}

- arguments: `accountId` `publicKey`
- arguments: `accountId` `--access-key`

**Example:**

```bash
near add-key example-acct.testnet Cxg2wgFYrdLTEkMu6j5D6aEZqTb3kXbmJygS48ZKbo1S
near add-key example-acct.testnet --access-key Cxg2wgFYrdLTEkMu6j5D6aEZqTb3kXbmJygS48ZKbo1S
```

<details>
Expand All @@ -455,7 +460,7 @@ near add-key example-acct.testnet Cxg2wgFYrdLTEkMu6j5D6aEZqTb3kXbmJygS48ZKbo1S

#### 2) add a `function access` key {#2-add-a-function-access-key}

- arguments: `accountId` `publicKey` `--contract-id`
- arguments: `accountId` `--access-key` `--contract-id`
- options: `--method-names` `--allowance`

> `accountId` is the account you are adding the key to
Expand All @@ -471,7 +476,7 @@ near add-key example-acct.testnet Cxg2wgFYrdLTEkMu6j5D6aEZqTb3kXbmJygS48ZKbo1S
**Example:**

```bash
near add-key example-acct.testnet GkMNfc92fwM1AmwH1MTjF4b7UZuceamsq96XPkHsQ9vi --contract-id example-contract.testnet --method-names example_method --allowance 30000000000
near add-key example-acct.testnet --access-key GkMNfc92fwM1AmwH1MTjF4b7UZuceamsq96XPkHsQ9vi --contract-id example-contract.testnet --method-names example_method --allowance 30000000000
```

<details>
Expand All @@ -486,6 +491,28 @@ near add-key example-acct.testnet GkMNfc92fwM1AmwH1MTjF4b7UZuceamsq96XPkHsQ9vi -
</p>
</details>

#### 3) add a `full access` key based on a seed phrase

- arguments: `accountId` `--seedPhrase="[your seed phrase]"`

**Example:**

```bash
near add-key example-acct.testnet --seedPhrase="cow moon right send now cool dense quark pretty see light after"
```

<details>
<summary><strong>Example Response</strong></summary>
<p>

Adding seed phrase as full access key = "cow moon right send now cool dense quark pretty see light after" to example-acct.testnet.
Transaction Id EwU1ooEvkR42HvGoJHu5ou3xLYT3JcgQwFV3fAwevGJg
To see the transaction in the transaction explorer, please open this url in your browser
https://explorer.testnet.near.org/transactions/EwU1ooEvkR42HvGoJHu5ou3xLYT3JcgQwFV3fAwevGJg

</p>
</details>

---

### `near delete-key` {#near-delete-key}
Expand Down