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
38 changes: 0 additions & 38 deletions docs/cli/cli_commands/offers/index.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/cli/cli_commands/orders/index.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/cli/cli_commands/providers/index.md

This file was deleted.

144 changes: 0 additions & 144 deletions docs/cli/cli_commands/workflows/create.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
id: "cli-files-delete"
title: "files delete"
slug: "/cli_commands/files/delete"
slug: "/commands/files/delete"
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`](/cli/cli_commands/files/upload) command.
The resource JSON file is created as a result of the [`files upload`](/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`](/cli/cli_c
[--help | -h]
```

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

## Arguments

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
id: "cli-files-download"
title: "files download"
slug: "/cli_commands/files/download"
slug: "/commands/files/download"
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`](/cli/cli_commands/files/upload) command.
The resource JSON file is created as a result of the [`files upload`](/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`](/cli/cli_c
[--help | -h]
```

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

## Arguments

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: "cli-files"
title: "files"
slug: "/cli_commands/files"
slug: "/commands/files"
sidebar_position: 3

---
Expand All @@ -14,6 +14,6 @@ Most of these commands require a Storj account and SPCTL configured to use it. R

| **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. |
| [files delete](/cli/commands/files/delete) | Deletes a file in remote storage. |
| [files download](/cli/commands/files/download) | Downloads and decrypt a file from remote storage. |
| [files upload](/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
@@ -1,23 +1,23 @@
---
id: "cli-files-upload"
title: "files upload"
slug: "/cli_commands/files/upload"
slug: "/commands/files/upload"
sidebar_label: "upload"
---

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`](/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.
- With the [`workflows create`](/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](/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`](/cli/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/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](/cli/cli_commands#command-syntax).
Read about the Super Protocol [command syntax](/cli/commands#command-syntax).

## Arguments

Expand All @@ -51,7 +51,7 @@ Read about the Super Protocol [command syntax](/cli/cli_commands#command-syntax)
| `--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](/cli/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/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 Down Expand Up @@ -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](/cli/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/commands/orders/replenish-deposit).

### Example 3. Use additional options

Expand Down
Loading
Loading