Skip to content
Merged

main #286

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
2 changes: 1 addition & 1 deletion docs/cli/commands/files/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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-access) section to create a bucket and access grants and set up SPCTL.
Most of these commands require a Storj account and SPCTL configured to use it. Refer to the [Set up Storj](/cli/#set-up-storj-access-optional) section to create a bucket and access grants and set up SPCTL.

## Commands

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/files/upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The primary purpose of this command is to make the uploading files available for

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](/cli#set-up-storj-access) 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-access-optional) 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 SPPI 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`](/cli/commands/solutions/prepare) command. For data, it is an archive containing the dataset files.
Expand Down Expand Up @@ -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](/cli#set-up-storj-access) 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-access-optional) section to create a bucket and access grants and set up SPCTL.

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

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ This section contains the list of commands for the Super Protocol CLI tool SPCTL
| [orders](/cli/commands/orders) | Manage your orders. |
| [offers](/cli/commands/offers) | View and manage Marketplace offers. |
| [providers](/cli/commands/providers) | View and manage offer providers. |
| [quotes](/cli/commands/quotes) | Verify the authenticity and integrity of a Trusted Execution Environment. |
| [quotes](/cli/commands/quotes) | Verify the authenticity and integrity of a <a id="tee"><span className="dashed-underline">Trusted Execution Environment</span></a>. |

## Command syntax

SPCTL uses the following syntax format for commands:
The syntax format for commands:

```
./spctl <command group> <command> <arguments> <options>
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/offers/add-slot.md
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] guide to create the initial offer requirements.

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

## Syntax

Expand Down Expand Up @@ -53,7 +53,7 @@ The offer slot JSON file must contain the following objects and strings:
+ `minTimeMinutes`: minutes; `0` for no limit
+ `price`: denominations of SPPI token
+ `priceType`: `1` for fixed price, `0` for price per hour; learn more about [price types](/fundamentals/orders#cost-and-pricing)
- `option`: object with internet access configuration (only for value offers)
- `option`: object with internet access configuration (only for <a id="value-offer"><span className="dashed-underline">value offers</span></a>)
+ `bandwidth`: bits per second
+ `traffic`: bytes
+ `externalPort`: `1` for yes, `0` for no
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/offers/delete-slot.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 10

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

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

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

Expand Down Expand Up @@ -41,7 +41,7 @@ Read about the Super Protocol [command syntax](/cli/commands#command-syntax).

## Example

The following command deletes a requirement slot with ID 47 in a value offer with ID 39:
The following command deletes a requirement slot with ID 47 in a <a id="value-offer"><span className="dashed-underline">value offer</span></a> with ID 39:

```
./spctl offers delete-slot value --offer 39 --slot 47
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/offers/disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 6

Disables an existing enabled offer.

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

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/offers/enable.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 7

Enables an existing disabled offer.

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

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/offers/get-slot.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Read about the Super Protocol [command syntax](/cli/commands#command-syntax).

## Example

The following command displays the information on a requirement slot with ID 47 in a value offer with ID 39:
The following command displays the information on a requirement slot with ID 47 in a <a id="value-offer"><span className="dashed-underline">value offer</span></a> with ID 39:

```
./spctl offers get-slot value --offer 39 --slot 47
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/offers/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ For both offer types:

### Example 1

The following command displays the IDs, names, and types of the first 30 value offers:
The following command displays the IDs, names, and types of the first 30 <a id="value-offer"><span className="dashed-underline">value offers</span></a>:

```
./spctl offers list value --limit 30
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/offers/update-slot.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 9

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](/cli#for-offer-providers).
**Important:** This command requires SPCTL with the [provider configuration file](/cli/#configure-spctl-for-providers).

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

Expand Down Expand Up @@ -45,7 +45,7 @@ Read about the Super Protocol [command syntax](/cli/commands#command-syntax).

## Example

The following command updates a slot with ID 47 in a value offer with ID 39 using the information in the file `offer-slot.json` in the SPCTL directory:
The following command updates a slot with ID 47 in a <a id="value-offer"><span className="dashed-underline">value offer</span></a> with ID 39 using the information in the file `offer-slot.json` in the SPCTL directory:

```
./spctl offers update-slot value --offer 39 --slot 47 --path ./offer-slot.json
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/offers/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Updates information of an existing offer using an offer description JSON file.

Refer to the [Providers and Offers] guide to create the initial offer description.

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

## Syntax

Expand Down Expand Up @@ -104,7 +104,7 @@ The file may contain only the fields that need to be updated. For example, to on

## Example

The following command updates an existing value offer with ID 39 using the information in the `updated-offer-39.json` in the SPCTL root directory:
The following command updates an existing <a id="value-offer"><span className="dashed-underline">value offer</span></a> with ID 39 using the information in the `updated-offer-39.json` in the SPCTL root directory:

```
./spctl offers update value 39 --path ./updated-offer-39.json
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/providers/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Updates the current provider using a provider info JSON file.

Provider Tools creates a provider info JSON file in [Step 4 of the Providers and Offers] guide.

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

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/quotes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 9

---

This command group contains a single command to verify the authenticity and integrity of a Trusted Execution Environment by examining the enclave quote.
This command group contains a single command to verify the authenticity and integrity of a <a id="tee"><span className="dashed-underline">Trusted Execution Environment</span></a> by examining the enclave quote.

## Command

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/solutions/prepare.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: "prepare"

Packs and signs a solution with [Gramine](https://gramineproject.io/) and writes a [manifest](https://gramine.readthedocs.io/en/stable/manifest-syntax.html).

This allows the execution of the "graminized" solution code inside a Trusted Execution Environment. When the solution is prepared and packed, you can [upload](/cli/commands/files/upload) the resulting archive to a distributed storage to use the solution in orders.
This allows the execution of the "graminized" solution code inside a <a id="tee"><span className="dashed-underline">Trusted Execution Environment</span></a>. When the solution is prepared and packed, you can [upload](/cli/commands/files/upload) the resulting archive to a distributed storage to use the solution in orders.

The input of the command is the following:

Expand Down
Loading
Loading