Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: "delete"

Deletes a file in remote storage using the information in a resource JSON file.

The resource JSON file is created as a result of the [`files upload`](/developers/cli_commands/files/upload) command.
The resource JSON file is created as a result of the [`files upload`](/cli/cli_commands/files/upload) command.

## Syntax

Expand All @@ -17,7 +17,7 @@ The resource JSON file is created as a result of the [`files upload`](/developer
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: "download"

Downloads a file from remote storage and decrypts it using the information in a resource JSON file.

The resource JSON file is created as a result of the [`files upload`](/developers/cli_commands/files/upload) command.
The resource JSON file is created as a result of the [`files upload`](/cli/cli_commands/files/upload) command.

## Syntax

Expand All @@ -17,7 +17,7 @@ The resource JSON file is created as a result of the [`files upload`](/developer
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
19 changes: 19 additions & 0 deletions docs/cli/cli_commands/files/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: "cli-files"
title: "files"
slug: "/cli_commands/files"
sidebar_position: 3

---

This command group contains commands to manage files in third-party storage such as Storj.

Most of these commands require a Storj account and SPCTL configured to use it. Refer to the [Set up Storj](/cli#set-up-storj) section to create a bucket and access grants and set up SPCTL.

## Commands

| **Command** | **Description** |
| :- | :- |
| [files delete](/cli/cli_commands/files/delete) | Deletes a file in remote storage. |
| [files download](/cli/cli_commands/files/download) | Downloads and decrypt a file from remote storage. |
| [files upload](/cli/cli_commands/files/upload) | Uploads a file to remote storage or creates a storage order. |
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ Uploads a file to remote storage such as Storj.

The primary purpose of this command is to make the uploading files available for download and execution. This is necessary in two cases:

- With the [`workflows create`](/developers/cli_commands/workflows/create) command, **users** can add the uploaded solution or data to an order instead of a Marketplace offer. In this case, a short-term storage period is enough.
- With the [`workflows create`](/cli/cli_commands/workflows/create) command, **users** can add the uploaded solution or data to an order instead of a Marketplace offer. In this case, a short-term storage period is enough.
- Solution and data **providers** can store the contents of their offers to make them available for customers' orders. This requires a long-term storage period.

Depending on the options, the command provides two ways to upload and store the files. Choose one that suits you better:

- **Uploads to storage directly.** This requires a Storj account and SPCTL [configured](/developers/cli_guides/configure#set-up-storj) to use it. The command will upload the file to the root directory of the bucket specified in the SPCTL configuration file.
- **Uploads to storage directly.** This requires a Storj account and SPCTL [configured](/cli#set-up-storj) to use it. The command will upload the file to the root directory of the bucket specified in the SPCTL configuration file.
- **Creates a storage order using a Marketplace storage offer.** This does not require a Storj account but requires paying TEE tokens for the order according to the offer pricing and selected lease duration.

The input of the command is a TAR.GZ archive file. For solutions, this file is created by the [`solutions prepare`](/developers/cli_commands/solutions/prepare) command. For data, it is an archive containing the dataset files.
The input of the command is a TAR.GZ archive file. For solutions, this file is created by the [`solutions prepare`](/cli/cli_commands/solutions/prepare) command. For data, it is an archive containing the dataset files.

The output of the command is a resource JSON file with the information for a compute provider on how to access the uploaded file.

Expand All @@ -36,7 +36,7 @@ The output of the command is a resource JSON file with the information for a com
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand All @@ -51,7 +51,7 @@ Read about the Super Protocol [command syntax](/developers/cli_commands#command-
| `--filename <string>` | Desired name of the resulting file in storage. The default is a random string. |
| `--output <path>` | Path to save the output resource JSON file. The default is `./resource.json`. |
| `--skip-encryption` | Flag to skip file encryption before uploading. The default is `false`. |
| `--metadata <path>` | Path to a metadata file for adding fields to the resource JSON file. This file is generated by the [solutions prepare](/developers/cli_commands/solutions/prepare) command. |
| `--metadata <path>` | Path to a metadata file for adding fields to the resource JSON file. This file is generated by the [solutions prepare](/cli/cli_commands/solutions/prepare) command. |
| `--max-concurrent <number>` | Maximum concurrent pieces to upload at once per transfer to limit the number of threads. Use only when dealing with a memory-constrained environment. |
| `--storage <offerId,slotId>` | Option to use a storage offer. State the storage offer ID and the requirement slot ID, separated by a comma. |
| `--min-rent-minutes <minutes>` | Storage lease period in minutes. Use this option together with `--storage`. The default is `60`. |
Expand All @@ -74,7 +74,7 @@ The following command uploads the `content.tar.gz` file located in the SPCTL roo
./spctl files upload content.tar.gz
```

To execute this command successfully, you need a Storj account and SPCTL configured to use it. Refer to the [Set up Storj](/developers/cli_guides/configure#set-up-storj) section to create a bucket and access grants and set up SPCTL.
To execute this command successfully, you need a Storj account and SPCTL configured to use it. Refer to the [Set up Storj](/cli#set-up-storj) section to create a bucket and access grants and set up SPCTL.

### Example 2. Upload by creating a storage order

Expand All @@ -89,7 +89,7 @@ Where:
- `--storage 25,33`: create a storage order using the [Storj DCS Offer](https://marketplace.superprotocol.com/storage?offer=offerId%3D25&tab=pricing) (offer ID: 25) and the requirement slot with ID 33.
- `--min-rent-minutes 120`: set the lease period for 120 minutes.

Since the `--storage` option is set, the command does not require a Storj account. However, when the lease period is over, the content will become unavailable unless you [replenish the order deposit](/developers/cli_commands/orders/replenish-deposit).
Since the `--storage` option is set, the command does not require a Storj account. However, when the lease period is over, the content will become unavailable unless you [replenish the order deposit](/cli/cli_commands/orders/replenish-deposit).

### Example 3. Use additional options

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@
id: "cli_commands"
title: "CLI Commands"
slug: "/cli_commands"
sidebar_position: 7
sidebar_position: 2
---

This section contains the list of commands for the Super Protocol CLI tool SPCTL.

[Configure SPCTL](/developers/cli_guides/configure) before using these commands. Be mindful of the [testnet limitations](/marketplace/limitations) when using the Marketplace CLI and GUI.
[Configure SPCTL](/cli) before using these commands. Be mindful of the [testnet limitations](/marketplace/limitations) when using the Marketplace CLI and GUI.

## Command groups

| **Group** | **Description** |
| :- | :- |
| [tokens](/developers/cli_commands/tokens) | Receive test TEE and POL test tokens; **testnet only**. |
| [solutions](/developers/cli_commands/solutions) | Prepare a solution for deployment. |
| [files](/developers/cli_commands/files) | Manage files in decentralized storage. |
| [workflows](/developers/cli_commands/workflows) | Create a new order. |
| [orders](/developers/cli_commands/orders) | Manage your orders. |
| [offers](/developers/cli_commands/offers) | View and manage Marketplace offers. |
| [providers](/developers/cli_commands/providers) | View and manage offer providers. |
| [quotes](/developers/cli_commands/quotes) | Verify the authenticity and integrity of a Trusted Execution Environment. |
| [tokens](/cli/cli_commands/tokens) | Receive test TEE and POL test tokens; **testnet only**. |
| [solutions](/cli/cli_commands/solutions) | Prepare a solution for deployment. |
| [files](/cli/cli_commands/files) | Manage files in decentralized storage. |
| [workflows](/cli/cli_commands/workflows) | Create a new order. |
| [orders](/cli/cli_commands/orders) | Manage your orders. |
| [offers](/cli/cli_commands/offers) | View and manage Marketplace offers. |
| [providers](/cli/cli_commands/providers) | View and manage offer providers. |
| [quotes](/cli/cli_commands/quotes) | Verify the authenticity and integrity of a Trusted Execution Environment. |

## Command syntax

Expand All @@ -30,13 +30,13 @@ SPCTL uses the following syntax format for commands:
./spctl <command group> <command> <arguments> <options>
```

_Command groups_ contain functionally related commands. Check the complete list of command groups in the [previous section](/developers/cli_commands#command-groups).
_Command groups_ contain functionally related commands. Check the complete list of command groups in the [previous section](/cli/cli_commands#command-groups).

_Commands_ perform a specific function, like placing an order or showing the list of providers.

For example, the [`tokens`](/developers/cli_commands/tokens) command group includes the following commands:
- [`balance`](/developers/cli_commands/tokens/balance): checks the balance
- [`request`](/developers/cli_commands/tokens/request): requests testnet tokens.
For example, the [`tokens`](/cli/cli_commands/tokens) command group includes the following commands:
- [`balance`](/cli/cli_commands/tokens/balance): checks the balance
- [`request`](/cli/cli_commands/tokens/request): requests testnet tokens.

_Options_ modify the command behavior and are prefixed by double hyphen `--`. For example, `--help` is an option that displays help information for a command.

Expand All @@ -56,7 +56,7 @@ Never include these special characters, except backslash `\`, in the final comma

### Example

The following is a mandatory option `--solution` of the [`workflows create`](/developers/cli_commands/workflows/create) command:
The following is a mandatory option `--solution` of the [`workflows create`](/cli/cli_commands/workflows/create) command:

```
--solution {<offerId>,[<slotId>] | <path>}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Creates an additional [requirement slot](/fundamentals/slots#requirements) in an

Refer to the [Providers and Offers](/developers/cli_guides/providers_offers#offer-requirements) guide to create the initial offer requirements.

**Important:** This command requires SPCTL with the [provider configuration file](/developers/cli_guides/configure#for-offer-providers).
**Important:** This command requires SPCTL with the [provider configuration file](/cli#for-offer-providers).

## Syntax

Expand All @@ -22,7 +22,7 @@ Refer to the [Providers and Offers](/developers/cli_guides/providers_offers#offe
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ sidebar_position: 12

Deletes a [requirement slot](/fundamentals/slots#requirements) in an [offer](/fundamentals/offers).

**Important:** This command requires SPCTL with the [provider configuration file](/developers/cli_guides/configure#for-offer-providers).
**Important:** This command requires SPCTL with the [provider configuration file](/cli#for-offer-providers).

Use the [`offers get`](/developers/cli_commands/offers/offers/get) command to get the IDs of all slots in an offer. Use the [`offers get-slot`](/developers/cli_commands/offers/slots/get-slot) command to get additional information on a slot.
Use the [`offers get`](/cli/cli_commands/offers/offers/get) command to get the IDs of all slots in an offer. Use the [`offers get-slot`](/cli/cli_commands/offers/slots/get-slot) command to get additional information on a slot.

## Syntax

Expand All @@ -22,7 +22,7 @@ Use the [`offers get`](/developers/cli_commands/offers/offers/get) command to ge
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 7

Disables an existing enabled offer.

**Important:** This command requires SPCTL with the [provider configuration file](/developers/cli_guides/configure#for-offer-providers).
**Important:** This command requires SPCTL with the [provider configuration file](/cli#for-offer-providers).

## Syntax

Expand All @@ -18,7 +18,7 @@ Disables an existing enabled offer.
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The command only works with offers that allow this operation.
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 8

Enables an existing disabled offer.

**Important:** This command requires SPCTL with the [provider configuration file](/developers/cli_guides/configure#for-offer-providers).
**Important:** This command requires SPCTL with the [provider configuration file](/cli#for-offer-providers).

## Syntax

Expand All @@ -18,7 +18,7 @@ Enables an existing disabled offer.
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Displays the information on an offer as stored on the blockchain.
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Displays the information on a [configuration option](/fundamentals/slots) of a c
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Options

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 13

Displays the information for a [requirement slot](/fundamentals/slots#requirements) in an offer.

Use the [`offers get`](/developers/cli_commands/offers/offers/get) command to get the IDs of all slots in an offer.
Use the [`offers get`](/cli/cli_commands/offers/offers/get) command to get the IDs of all slots in an offer.

## Syntax

Expand All @@ -21,7 +21,7 @@ Use the [`offers get`](/developers/cli_commands/offers/offers/get) command to ge
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Displays information on an offer.
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
38 changes: 38 additions & 0 deletions docs/cli/cli_commands/offers/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
id: "cli-commands-offers"
title: "offers"
slug: "/cli_commands/offers"
sidebar_position: 6

---

This command group contains commands to view and manage [offers](/fundamentals/offers). Note that [Marketplace GUI](/developers/marketplace) can be more convenient to use than most of these commands.

## Commands

| **Command** | **Description** |
| :- | :- |
| [offers list](/cli/cli_commands/offers/offers/list) | Lists available offers. |
| [offers get](/cli/cli_commands/offers/offers/get) | Displays information on an offer. |
| [offers get-info](/cli/cli_commands/offers/offers/get-info) | Displays information on an offer as stored on the blockchain. |
| [offers download-content](/cli/cli_commands/offers/offers/download-content) | Downloads the content of an offer. |
| [offers update](/cli/cli_commands/offers/offers/update) | Updates an offer. |
| [offers disable](/cli/cli_commands/offers/offers/disable) | Disables an enabled offer. |
| [offers enable](/cli/cli_commands/offers/offers/enable) | Enables a disabled offer. |

### Slot-related commands

| **Command** | **Description** |
| :- | :- |
| [offers add-slot](/cli/cli_commands/offers/slots/add-slot) | Adds a new slot to an existing offer. |
| [offers update-slot](/cli/cli_commands/offers/slots/update-slot) | Updates a slot. |
| [offers delete-slot](/cli/cli_commands/offers/slots/delete-slot) | Deletes a slot. |
| [offers get-slot](/cli/cli_commands/offers/slots/get-slot) | Displays information on a slot. |

### Option-related command

This command only works with compute offers.

| **Command** | **Description** |
| :- | :- |
| [offers get-option](/cli/cli_commands/offers/options/get-option) | Displays information for an option. |
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Displays a list of available offers.
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ sidebar_position: 11

Updates a [requirement slot](/fundamentals/slots#requirements) in an existing offer using the information in a JSON file.

**Important:** This command requires SPCTL with the [provider configuration file](/developers/cli_guides/configure#for-offer-providers).
**Important:** This command requires SPCTL with the [provider configuration file](/cli#for-offer-providers).

Use the [`offers get`](/developers/cli_commands/offers/offers/get) command to get the IDs of all slots in an offer. Use the [`offers get-slot`](/developers/cli_commands/offers/slots/get-slot) command to get additional information on a slot.
Use the [`offers get`](/cli/cli_commands/offers/offers/get) command to get the IDs of all slots in an offer. Use the [`offers get-slot`](/cli/cli_commands/offers/slots/get-slot) command to get additional information on a slot.

Refer to [Offer requirements](/developers/cli_guides/providers_offers#offer-requirements) to create the initial offer requirements. Refer to the description of the [`offers add-slot`](/developers/cli_commands/offers/slots/add-slot) command for the JSON file format and object descriptions.
Refer to [Offer requirements](/developers/cli_guides/providers_offers#offer-requirements) to create the initial offer requirements. Refer to the description of the [`offers add-slot`](/cli/cli_commands/offers/slots/add-slot) command for the JSON file format and object descriptions.

## Syntax

Expand All @@ -25,7 +25,7 @@ Refer to [Offer requirements](/developers/cli_guides/providers_offers#offer-requ
[--help | -h]
```

Read about the Super Protocol [command syntax](/developers/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax).

## Arguments

Expand Down
Loading
Loading