oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
Code Releases Activity

Minor adjustments

Browse Source
This commit is contained in:
Ana Loznianu 2023-10-03 14:18:40 +03:00
parent 1bc398da9f
commit 02d8e1258a
4 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
developers/ocean-cli/consume.md
View File

@ -1,12 +1,12 @@
# Consume a Dataset 📥
The process of consuming an asset is remarkably straightforward. To achieve this, you only need to execute a single command:
The process of consuming an asset is straightforward. To achieve this, you only need to execute a single command:
```bash
npm run cli download 'assetDID' 'download-location-path'
```
In this command, replace 'assetDID' with the specific DID of the asset you want to consume, and 'download-location-path' with the desired path where you wish to store the downloaded asset content
In this command, replace `assetDID`` with the specific DID of the asset you want to consume, and `download-location-path`` with the desired path where you wish to store the downloaded asset content
Once executed, this command orchestrates both the **ordering** of a [datatoken](../contracts/datatokens.md) and the subsequent download operation. The asset's content will be automatically retrieved and saved at the specified location, simplifying the consumption process for users.

6
developers/ocean-cli/edit.md
View File

@ -10,9 +10,11 @@ Obtaining the DDO of an asset is a straightforward process. You can accomplish t
npm run cli getDDO 'assetDID'
```
<figure><img src="../../.gitbook/assets/cli/getAsset.png" alt=""><figcaption>Get DDO</figcaption></figure>
<figure><img src="../../.gitbook/assets/cli/getAsset.png" alt=""><figcaption>Retrieve DDO</figcaption></figure>
After retrieving the asset's DDO and saving it as a JSON file, you can proceed to edit the metadata as needed. Once you've made the necessary changes, you can utilize the following command to apply the updated metadata:
## Edit the Dataset
After retrieving the asset's DDO and saving it as a JSON file, you can proceed to edit the metadata as needed. Once you've made the necessary changes, you can utilize the following command to apply the updated metadata:
```bash
npm run cli editAsset 'DATASET_DID' 'PATH_TO_UPDATED_FILE`

2
developers/ocean-cli/publish.md
View File

@ -2,7 +2,7 @@
Once you've configured the RPC environment variable, you're ready to publish a new dataset on the connected network. Our flexible setup allows you to switch to a different network simply by substituting the RPC endpoint with one corresponding to another network. 🌐
To initiate the dataset publishing process, we'll start by updating the helper [DDO](../ddo-specification.md)(Decentralized Data Object) example named "SimpleDownloadDataset.json." This example can be found in the "./metadata" folder, located at the root directory of the cloned Ocean CLI project.
To initiate the dataset publishing process, we'll start by updating the helper [DDO](../ddo-specification.md)(Decentralized Data Object) example named "SimpleDownloadDataset.json." This example can be found in the `./metadata`` folder, located at the root directory of the cloned Ocean CLI project.
```json
{

4
developers/ocean-cli/run-c2d.md
View File

@ -20,7 +20,7 @@ In this command, replace `DATASET_DID` with the specific DID of the dataset you
To obtain the compute results, we'll follow a two-step process. First, we'll employ the `getJobStatus`` method, patiently monitoring its status until it signals the job's completion. Afterward, we'll utilize this method to acquire the actual results.
## Monitor Job Status
### Monitor Job Status
To track the status of a job, you'll require both the dataset DID and the compute job DID. You can initiate this process by executing the following command:
```bash
@ -31,7 +31,7 @@ Executing this command will allow you to observe the job's status and verify its
<figure><img src="../../.gitbook/assets/cli/jobstatus.png" alt=""><figcaption>Get Job Status</figcaption></figure>
## Download the results
### Download C2D Results
For the second method, the dataset DID is no longer required. Instead, you'll need to specify the job ID, the index of the result you wish to download from the available results for that job, and the destination folder where you want to save the downloaded content. The corresponding command is as follows: