Skip to content

Commit

Permalink
Update cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nvm-bot committed Sep 16, 2024
1 parent 98c270f commit 446200c
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 2 deletions.
60 changes: 60 additions & 0 deletions docs/cli/cli_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -2126,4 +2126,64 @@ ncli app download did:nv:afd733c23c41af948be7ec039c3fb2048d437e082a69ea3f336cdf4



### create-api-key [name]
It creates a new NVM API Key<br/>

Nevermined API Keys allow to interact with the protocol in a programatic way. This command allows the generation of NVM API Keys. NOTE: This method requires the user to setup the ZERO_PROJECT_ID environment variable.<br/>

#### Positional Arguments

| Name of the Argument | Type | Is required? | Default value | Description |
|----------------------|------|-------------:|--------------:|-------------|
| **name** | `string` | | | The name of the NVM API Key to create |



#### Example/s


```bash
ncli app create-api-key &quot;My Test API Key&quot;
```



### list-api-keys
It lists all the NVM API Keys associated to the user<br/>

This command lists allt he NVM API Keys created by the user.<br/>



#### Example/s


```bash
ncli app list-api-keys
```



### revoke-api-key [hash]
It revokes a existing NVM API Key<br/>

Nevermined API Keys allow to interact with the protocol in a programatic way. This command allows to revoke an existing NVM API Keys.<br/>

#### Positional Arguments

| Name of the Argument | Type | Is required? | Default value | Description |
|----------------------|------|-------------:|--------------:|-------------|
| **hash** | `string` | | | The hash of the NVM API Key to revoke |



#### Example/s


```bash
ncli app revoke-api-key &quot;eyJhbGciOiJFUzI1NksifQ.eyJpc&quot;
```




4 changes: 2 additions & 2 deletions docs/cli/environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,8 @@ The Native token is **PEAQ**. This environment has the network name **peaq-mainn

### Nevermined configuration

The Nevermined contracts deployed have the version: **3.5.7** The Nevermined contracts are labeled with the tag name: **public**
The Nevermined contracts deployed have the version: **3.5.8** The Nevermined contracts are labeled with the tag name: **public**
The Marketplace API used can be found on https://marketplace-api.peaq.nevermined.app. <br/>
The Nevermined Node can be found on http://node.peaq.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.<br/>
The Nevermined Node can be found on https://node.peaq.nevermined.app and uses the public address **0x824dbcE5E9C96C5b8ce2A35a25a5ab87eD1D00b1**.<br/>


0 comments on commit 446200c

Please sign in to comment.