diff --git a/docs/cli/Guides/collaboration.md b/docs/archive/cli/Guides/collaboration.md similarity index 85% rename from docs/cli/Guides/collaboration.md rename to docs/archive/cli/Guides/collaboration.md index 47e5a7d8..14a8e178 100644 --- a/docs/cli/Guides/collaboration.md +++ b/docs/archive/cli/Guides/collaboration.md @@ -1,7 +1,7 @@ --- id: "collaboration" title: "Two-party Collaboration" -slug: "/guides/collaboration" +slug: "/cli/guides/collaboration" displayed_sidebar: null unlisted: true --- @@ -57,35 +57,35 @@ sequenceDiagram **Preparation** -Alice builds a solution—a Docker image containing her script ([1](/cli/guides/collaboration#alice-1-build-a-solution)). She uploads the solution using SPCTL ([2](/cli/guides/collaboration#alice-2-upload-the-solution)) and grants Bob access for verification ([3](/cli/guides/collaboration#alice-3-send-the-solution-to-bob)). +Alice builds a solution—a Docker image containing her script ([1](/archive/cli/guides/collaboration#alice-1-build-a-solution)). She uploads the solution using SPCTL ([2](/archive/cli/guides/collaboration#alice-2-upload-the-solution)) and grants Bob access for verification ([3](/archive/cli/guides/collaboration#alice-3-send-the-solution-to-bob)). -Bob (or an independent auditor) downloads the solution ([4](/cli/guides/collaboration#bob-4-download-the-solution)) and verifies that it is safe to process his data ([5](/cli/guides/collaboration#bob-5-verify-the-solution)). +Bob (or an independent auditor) downloads the solution ([4](/archive/cli/guides/collaboration#bob-4-download-the-solution)) and verifies that it is safe to process his data ([5](/archive/cli/guides/collaboration#bob-5-verify-the-solution)). -Bob uploads his dataset to remote storage using SPCTL ([6](/cli/guides/collaboration#bob-6-upload-the-dataset)). The dataset is automatically encrypted during upload, and only Bob holds the key. +Bob uploads his dataset to remote storage using SPCTL ([6](/archive/cli/guides/collaboration#bob-6-upload-the-dataset)). The dataset is automatically encrypted during upload, and only Bob holds the key. -Bob creates an offer on the Marketplace ([7](/cli/guides/collaboration#bob-7-create-an-offer)). The offer requires Bob's manual approval for use. He shares the offer's IDs with Alice. +Bob creates an offer on the Marketplace ([7](/archive/cli/guides/collaboration#bob-7-create-an-offer)). The offer requires Bob's manual approval for use. He shares the offer's IDs with Alice. **Execution** -Alice places an order on Super Protocol using her solution and Bob's offer ID ([8](/cli/guides/collaboration#alice-8-place-an-order)). The order remains **Blocked** by the data suborder. +Alice places an order on Super Protocol using her solution and Bob's offer ID ([8](/archive/cli/guides/collaboration#alice-8-place-an-order)). The order remains **Blocked** by the data suborder. -Bob manually approves the usage of his dataset for the image with a specific hash ([9](/cli/guides/collaboration#bob-9-complete-the-data-suborder)). If this hash matches the actual solution hash, the CVM begins to process the order. If the hashes do not match, the order will be terminated with an error. +Bob manually approves the usage of his dataset for the image with a specific hash ([9](/archive/cli/guides/collaboration#bob-9-complete-the-data-suborder)). If this hash matches the actual solution hash, the CVM begins to process the order. If the hashes do not match, the order will be terminated with an error. -Once the computation finishes, Alice can download the result ([10](/cli/guides/collaboration#alice-10-download-the-order-results)). All the data within the TEE (solution, dataset, order results, etc.) is automatically deleted. +Once the computation finishes, Alice can download the result ([10](/archive/cli/guides/collaboration#alice-10-download-the-order-results)). All the data within the TEE (solution, dataset, order results, etc.) is automatically deleted. -Both Alice and Bob can retrieve the order report ([11](/cli/guides/collaboration#alice-and-bob-11-get-the-order-report)) that confirms the authenticity of the entire trusted setup. +Both Alice and Bob can retrieve the order report ([11](/archive/cli/guides/collaboration#alice-and-bob-11-get-the-order-report)) that confirms the authenticity of the entire trusted setup. ## Prerequisites **Alice**: -- [SPCTL](/cli) +- [SPCTL](/archive/cli) - Docker **Bob**: -- [SPCTL](/cli) -- [Provider Tools](/cli/guides/provider-tools) +- [SPCTL](/archive/cli) +- [Provider Tools](/archive/cli/guides/provider-tools) ## Preparation diff --git a/docs/cli/Guides/comfyui.md b/docs/archive/cli/Guides/comfyui.md similarity index 92% rename from docs/cli/Guides/comfyui.md rename to docs/archive/cli/Guides/comfyui.md index ddc23efb..16832ec8 100644 --- a/docs/cli/Guides/comfyui.md +++ b/docs/archive/cli/Guides/comfyui.md @@ -1,7 +1,7 @@ --- id: "comfyui" title: "Custom ComfyUI Workflow" -slug: "/guides/solutions/comfyui" +slug: "/cli/guides/solutions/comfyui" sidebar_position: 4 --- @@ -12,7 +12,7 @@ This guide provides step-by-step instructions for preparing a **ComfyUI** workfl :::note -Due to [testnet limitations](/marketplace/limitations), the total size of model files should not exceed 13 GB. Support for bigger models will be available in the future. +Due to [testnet limitations](/archive/marketplace/limitations), the total size of model files should not exceed 13 GB. Support for bigger models will be available in the future. ::: @@ -93,7 +93,7 @@ You can prepare your model, workflow, and custom node files manually or using Do - Replace `` with the name of the output directory. - The output directory is ready for [upload](/marketplace/guides/deploy-model#2-create-an-offer) to Super Protocol. + The output directory is ready for [upload](/archive/marketplace/guides/deploy-model#2-create-an-offer) to Super Protocol. @@ -154,7 +154,7 @@ You can prepare your model, workflow, and custom node files manually or using Do └── my-openjourney-workflow.json ``` - The model directory is ready for [upload](/marketplace/guides/deploy-model#2-create-an-offer) to Super Protocol. + The model directory is ready for [upload](/archive/marketplace/guides/deploy-model#2-create-an-offer) to Super Protocol. diff --git a/docs/cli/Guides/deploy-app/deploy-app-example.md b/docs/archive/cli/Guides/deploy-app/deploy-app-example.md similarity index 96% rename from docs/cli/Guides/deploy-app/deploy-app-example.md rename to docs/archive/cli/Guides/deploy-app/deploy-app-example.md index edb21fd1..af72b8a3 100644 --- a/docs/cli/Guides/deploy-app/deploy-app-example.md +++ b/docs/archive/cli/Guides/deploy-app/deploy-app-example.md @@ -1,11 +1,11 @@ --- id: "deploy-app-example" title: "Example: Python script" -slug: "/guides/deploy-app/example" +slug: "/cli/guides/deploy-app/example" sidebar_position: 1 --- -This guide serves as an example to the more general [deployment guide](/cli/guides/deploy-app) and shows how to deploy a Python script on Super Protocol without modifying its code. +This guide serves as an example to the more general [deployment guide](/archive/cli/guides/deploy-app) and shows how to deploy a Python script on Super Protocol without modifying its code. The [simple script](/files/usd_to_crypto.py) used here as an example calculates how much Bitcoin (BTC) and Ether (ETH) can be bought for given amount in US dollars: @@ -19,7 +19,7 @@ In this deployment, the script will be the my-solution.tar.gz ### 1.4. Upload the archive -From your SPCTL directory, [upload](/cli/commands/files/upload) the archive with your solution: +From your SPCTL directory, [upload](/archive/cli/commands/files/upload) the archive with your solution: ```shell ./spctl files upload \ @@ -98,7 +98,7 @@ tar -czvf my_data.tar.gz -C ./data . ### 2.2. Upload the archive -From your SPCTL directory, [upload](/cli/commands/files/upload) the archive with your data, just like you did with the solution: +From your SPCTL directory, [upload](/archive/cli/commands/files/upload) the archive with your data, just like you did with the solution: ```shell ./spctl files upload \ @@ -116,7 +116,7 @@ For example: ## 3. Deploy -Place an order using the [`workflows create`](/cli/commands/workflows/create) command. For example: +Place an order using the [`workflows create`](/archive/cli/commands/workflows/create) command. For example: ```shell ./spctl workflows create \ @@ -142,7 +142,7 @@ For example: ./spctl orders get 256587 ``` -If the status is `Done` or `Error`, you can [download the order result](/cli/commands/orders/download-result): +If the status is `Done` or `Error`, you can [download the order result](/archive/cli/commands/orders/download-result): ```shell ./spctl orders download-result diff --git a/docs/cli/Guides/multi-party-collab.md b/docs/archive/cli/Guides/multi-party-collab.md similarity index 83% rename from docs/cli/Guides/multi-party-collab.md rename to docs/archive/cli/Guides/multi-party-collab.md index b9176b09..8ba4403c 100644 --- a/docs/cli/Guides/multi-party-collab.md +++ b/docs/archive/cli/Guides/multi-party-collab.md @@ -1,7 +1,7 @@ --- id: "fine-tune" title: "Multi-Party Collaboration" -slug: "/guides/multi-party-collab" +slug: "/cli/guides/multi-party-collab" sidebar_position: 7 --- @@ -41,11 +41,11 @@ sequenceDiagram ```
-Carol builds a solution—a Docker image containing her training engine and script ([1](/cli/guides/multi-party-collab#carol-1-build-a-solution)). She uploads the solution using SPCTL ([2](/cli/guides/multi-party-collab#carol-2-upload-the-solution)) and grants Alice and Bob access for verification ([3](/cli/guides/multi-party-collab#carol-3-send-the-solution-to-alice-and-bob)). +Carol builds a solution—a Docker image containing her training engine and script ([1](/archive/cli/guides/multi-party-collab#carol-1-build-a-solution)). She uploads the solution using SPCTL ([2](/archive/cli/guides/multi-party-collab#carol-2-upload-the-solution)) and grants Alice and Bob access for verification ([3](/archive/cli/guides/multi-party-collab#carol-3-send-the-solution-to-alice-and-bob)). -Alice and Bob download the solution ([4](/cli/guides/multi-party-collab#alice-and-bob-4-download-the-solution)) and verify that it is safe to process their data ([5](/cli/guides/multi-party-collab#alice-and-bob-5-verify-the-solution)). +Alice and Bob download the solution ([4](/archive/cli/guides/multi-party-collab#alice-and-bob-4-download-the-solution)) and verify that it is safe to process their data ([5](/archive/cli/guides/multi-party-collab#alice-and-bob-5-verify-the-solution)). -If Carol cannot share the code with Alice and Bob, and a third-party auditor is involved, the workflow will differ slightly. After uploading, Carol must also create a solution offer on Super Protocol Marketplace (similar to Bob's [Step 8](/cli/guides/multi-party-collab#bob-8-create-an-offer)). +If Carol cannot share the code with Alice and Bob, and a third-party auditor is involved, the workflow will differ slightly. After uploading, Carol must also create a solution offer on Super Protocol Marketplace (similar to Bob's [Step 8](/archive/cli/guides/multi-party-collab#bob-8-create-an-offer)). **Prepare the data**: @@ -64,9 +64,9 @@ sequenceDiagram ```
-Alice uploads her model ([6](/cli/guides/multi-party-collab#alice-6-upload-the-model)) and Bob uploads his dataset ([7](/cli/guides/multi-party-collab#bob-7-upload-the-dataset)) to remote storage using SPCTL. Files are automatically encrypted during upload, and only the uploader holds the key. +Alice uploads her model ([6](/archive/cli/guides/multi-party-collab#alice-6-upload-the-model)) and Bob uploads his dataset ([7](/archive/cli/guides/multi-party-collab#bob-7-upload-the-dataset)) to remote storage using SPCTL. Files are automatically encrypted during upload, and only the uploader holds the key. -Bob creates an offer on the Marketplace ([8](/cli/guides/multi-party-collab#bob-8-create-an-offer)). The offer requires Bob's manual approval for use. He shares the offer's IDs with Alice. +Bob creates an offer on the Marketplace ([8](/archive/cli/guides/multi-party-collab#bob-8-create-an-offer)). The offer requires Bob's manual approval for use. He shares the offer's IDs with Alice. **Execute**: @@ -92,28 +92,28 @@ sequenceDiagram ```
-Alice places an order on Super Protocol ([9](/cli/guides/multi-party-collab#alice-9-place-an-order)), adding the solution, her model, and Bob's offer. The order does not proceed automatically and remains `Blocked`. +Alice places an order on Super Protocol ([9](/archive/cli/guides/multi-party-collab#alice-9-place-an-order)), adding the solution, her model, and Bob's offer. The order does not proceed automatically and remains `Blocked`. -Bob manually approves the usage of his dataset for the image with a specific hash ([10](/cli/guides/multi-party-collab#bob-10-complete-the-data-suborder)). If this hash matches the actual solution hash, the CVM begins to process the order. If the hashes do not match, the order will be terminated with an error. +Bob manually approves the usage of his dataset for the image with a specific hash ([10](/archive/cli/guides/multi-party-collab#bob-10-complete-the-data-suborder)). If this hash matches the actual solution hash, the CVM begins to process the order. If the hashes do not match, the order will be terminated with an error. -When the order is complete, Alice downloads the result ([11](/cli/guides/multi-party-collab#alice-11-download-the-order-results)). All the data within the TEE (solution, AI model, dataset, order results, etc.) is automatically deleted. +When the order is complete, Alice downloads the result ([11](/archive/cli/guides/multi-party-collab#alice-11-download-the-order-results)). All the data within the TEE (solution, AI model, dataset, order results, etc.) is automatically deleted. -Both Alice and Bob can retrieve the order report ([12](/cli/guides/multi-party-collab#alice-and-bob-12-get-the-order-report)) that confirms the authenticity of the entire trusted setup. +Both Alice and Bob can retrieve the order report ([12](/archive/cli/guides/multi-party-collab#alice-and-bob-12-get-the-order-report)) that confirms the authenticity of the entire trusted setup. ## Prerequisites **Alice**: -- [SPCTL](/cli) +- [SPCTL](/archive/cli) **Bob**: -- [SPCTL](/cli) -- [Provider Tools](/cli/guides/provider-tools) +- [SPCTL](/archive/cli) +- [Provider Tools](/archive/cli/guides/provider-tools) **Carol**: -- [SPCTL](/cli) +- [SPCTL](/archive/cli) - Docker ## Prepare the solution @@ -138,7 +138,7 @@ Always use absolute paths, such as `/sp/...`. ::: -You may either include the training scripts in the image or upload them separately using SPCTL. In this case, Alice will need to attach the uploaded scripts to the order as `--data` at [Step 9](/cli/guides/multi-party-collab#alice-9-place-an-order). +You may either include the training scripts in the image or upload them separately using SPCTL. In this case, Alice will need to attach the uploaded scripts to the order as `--data` at [Step 9](/archive/cli/guides/multi-party-collab#alice-9-place-an-order). You can find several Dockerfile examples in the [Super-Protocol/solutions](https://github.com/Super-Protocol/solutions) GitHub repository. diff --git a/docs/cli/Guides/provider-tools.md b/docs/archive/cli/Guides/provider-tools.md similarity index 93% rename from docs/cli/Guides/provider-tools.md rename to docs/archive/cli/Guides/provider-tools.md index 8c6c7f79..7eb88d09 100644 --- a/docs/cli/Guides/provider-tools.md +++ b/docs/archive/cli/Guides/provider-tools.md @@ -1,7 +1,7 @@ --- id: "provider-tools" title: "Provider Tools" -slug: "/guides/provider-tools" +slug: "/cli/guides/provider-tools" sidebar_position: 1 --- @@ -132,13 +132,13 @@ Providers need another copy of SPCTL configured to manage their offers. Save and close the file. - 3. Generate a key for order result encryption using the [`workflows generate-key`](/cli/commands/workflows/generate-key) command. Open `config.json` again and set the generated key to `workflow.resultEncryption.key`. Save and close the file. + 3. Generate a key for order result encryption using the [`workflows generate-key`](/archive/cli/commands/workflows/generate-key) command. Open `config.json` again and set the generated key to `workflow.resultEncryption.key`. Save and close the file. ### Set up Storj access (optional) -If you already [set up Storj access](/cli/#set-up-storj-access-optional) for your regular SPCTL, you may reuse the same credentials for your provider's SPCTL. +If you already [set up Storj access](/archive/cli/#set-up-storj-access-optional) for your regular SPCTL, you may reuse the same credentials for your provider's SPCTL. If you skip this step, Super Protocol will automatically provide you with 20 GB of storage. diff --git a/docs/cli/Guides/tgwui.md b/docs/archive/cli/Guides/tgwui.md similarity index 91% rename from docs/cli/Guides/tgwui.md rename to docs/archive/cli/Guides/tgwui.md index 66ac340a..ef058cdf 100644 --- a/docs/cli/Guides/tgwui.md +++ b/docs/archive/cli/Guides/tgwui.md @@ -1,7 +1,7 @@ --- id: "tgwui" title: "TGWUI and ComfyUI With Tunnels" -slug: "/guides/solutions/tgwui" +slug: "/cli/guides/solutions/tgwui" sidebar_position: 3 --- @@ -12,7 +12,7 @@ This guide provides step-by-step instructions for uploading and deploying an AI ## Prerequisites -- [SPCTL](/cli/) +- [SPCTL](/archive/cli/) - BNB and SPPI tokens (opBNB) to pay for transactions and orders ## 1. Prepare @@ -41,9 +41,9 @@ Ensure your model meets the Super Protocol requirements: - Text-to-Video - Mask Generation -If you plan to deploy a ComfyUI workflow with custom nodes, [prepare the files](/cli/guides/solutions/comfyui) before proceeding to the next step. For security reasons, you cannot upload custom nodes directly to a deployed ComfyUI. +If you plan to deploy a ComfyUI workflow with custom nodes, [prepare the files](/archive/cli/guides/solutions/comfyui) before proceeding to the next step. For security reasons, you cannot upload custom nodes directly to a deployed ComfyUI. -1.2. Due to [testnet limitations](/marketplace/limitations), the total size of model files should not exceed 13 GB. Support for bigger models will be available in the future. +1.2. Due to [testnet limitations](/archive/marketplace/limitations), the total size of model files should not exceed 13 GB. Support for bigger models will be available in the future. ## 2. Upload the model @@ -65,7 +65,7 @@ Replace `` with the path to the dataset directory, for example: ## 3. Deploy tunnels -3.1. Place an order to deploy a [confidential tunnel](/fundamentals/tunnels): +3.1. Place an order to deploy a [confidential tunnel](/archive/fundamentals/tunnels): ```shell ./spctl workflows create --tee 7 --solution 19 @@ -226,12 +226,12 @@ If you suspect something went wrong, check the order status: Replace `` with the main order ID from the previous step. -The most important statuses (see the [full list](/fundamentals/orders#compute-order)): +The most important statuses (see the [full list](/archive/fundamentals/orders#compute-order)): - **Processing**: The compute is executing the order inside a TEE. Your model is either already available or will be available soon. - **In Queue**: The order is waiting for the compute to become available. This status appears only if the compute is overloaded with orders. If this status persists for a few minutes, place a new main order the same tunnel order and engine configuration but another compute offer. - **Done**: The order is completed successfully and the model's UI is no longer available. -- **Error**: The order completed with an error. [Download the order results](/cli/commands/orders/download-result) to get more information about the error. +- **Error**: The order completed with an error. [Download the order results](/archive/cli/commands/orders/download-result) to get more information about the error. ## Support diff --git a/docs/cli/Guides/unsloth.md b/docs/archive/cli/Guides/unsloth.md similarity index 98% rename from docs/cli/Guides/unsloth.md rename to docs/archive/cli/Guides/unsloth.md index 70ae7f67..ee5a81ab 100644 --- a/docs/cli/Guides/unsloth.md +++ b/docs/archive/cli/Guides/unsloth.md @@ -1,17 +1,17 @@ --- id: "unsloth" title: "Fine-Tuning With Unsloth" -slug: "/guides/solutions/unsloth" +slug: "/cli/guides/solutions/unsloth" sidebar_position: 5 --- This guide provides step-by-step instructions for fine-tuning an AI model using the Super Protocol packaging of [Unsloth](https://unsloth.ai/), an open-source framework for LLM fine-tuning and reinforcement learning. -The solution allows you to run fine-tuning within Super Protocol's Trusted Execution Environment (TEE). This provides enhanced security and privacy and enables a range of [confidential collaboration](/cli/guides/multi-party-collab) scenarios. +The solution allows you to run fine-tuning within Super Protocol's Trusted Execution Environment (TEE). This provides enhanced security and privacy and enables a range of [confidential collaboration](/archive/cli/guides/multi-party-collab) scenarios. ## Prerequisites -- [SPCTL](/cli/) +- [SPCTL](/archive/cli/) - Git - BNB and SPPI tokens (opBNB) to pay for transactions and orders diff --git a/docs/cli/Guides/vllm.md b/docs/archive/cli/Guides/vllm.md similarity index 98% rename from docs/cli/Guides/vllm.md rename to docs/archive/cli/Guides/vllm.md index d701a650..00a3b20d 100644 --- a/docs/cli/Guides/vllm.md +++ b/docs/archive/cli/Guides/vllm.md @@ -1,7 +1,7 @@ --- id: "vllm" title: "Inference With vLLM" -slug: "/guides/solutions/vllm" +slug: "/cli/guides/solutions/vllm" sidebar_position: 6 --- @@ -9,7 +9,7 @@ This guide provides step-by-step instructions for running an AI model inference ## Prerequisites -- [SPCTL](/cli/) +- [SPCTL](/archive/cli/) - Git - BNB and SPPI tokens (opBNB) to pay for transactions and orders diff --git a/docs/cli/commands/files/calculate-hash.md b/docs/archive/cli/commands/files/calculate-hash.md similarity index 95% rename from docs/cli/commands/files/calculate-hash.md rename to docs/archive/cli/commands/files/calculate-hash.md index e6fb2478..ff39c359 100644 --- a/docs/cli/commands/files/calculate-hash.md +++ b/docs/archive/cli/commands/files/calculate-hash.md @@ -1,7 +1,7 @@ --- id: "cli-files-calculate-hash" title: "files calculate-hash" -slug: "/commands/files/calculate-hash" +slug: "/cli/commands/files/calculate-hash" sidebar_label: "calculate-hash" sidebar_position: 2 --- diff --git a/docs/cli/commands/files/delete.md b/docs/archive/cli/commands/files/delete.md similarity index 85% rename from docs/cli/commands/files/delete.md rename to docs/archive/cli/commands/files/delete.md index 25fb55d9..527b14ee 100644 --- a/docs/cli/commands/files/delete.md +++ b/docs/archive/cli/commands/files/delete.md @@ -1,7 +1,7 @@ --- id: "cli-files-delete" title: "files delete" -slug: "/commands/files/delete" +slug: "/cli/commands/files/delete" sidebar_label: "delete" sidebar_position: 4 --- @@ -21,13 +21,13 @@ Deletes files in remote storage using the information in a resource JSON file. |
**Name**
|
**Description**
| | :- | :- | -| `` | Path to a resource JSON file. This file is created as a result of the
[`files upload`](/cli/commands/files/upload) command. | +| `` | Path to a resource JSON file. This file is created as a result of the
[`files upload`](/archive/cli/commands/files/upload) command. | ## Options |
**Name**
|
**Description**
| | :- | :- | -| `--use-addon` | Option required to delete files that were [uploaded](/cli/commands/files/upload) with this option. | +| `--use-addon` | Option required to delete files that were [uploaded](/archive/cli/commands/files/upload) with this option. | | `--config ` | Path to the SPCTL configuration file.
Default: `./config.json`. | | `--help`, `-h` | Help for the command. | diff --git a/docs/cli/commands/files/download.md b/docs/archive/cli/commands/files/download.md similarity index 86% rename from docs/cli/commands/files/download.md rename to docs/archive/cli/commands/files/download.md index 15fbc24f..b6c6401c 100644 --- a/docs/cli/commands/files/download.md +++ b/docs/archive/cli/commands/files/download.md @@ -1,7 +1,7 @@ --- id: "cli-files-download" title: "files download" -slug: "/commands/files/download" +slug: "/cli/commands/files/download" sidebar_label: "download" sidebar_position: 3 --- @@ -20,14 +20,14 @@ Downloads files from remote storage and decrypts it using the information in a r |
**Name**
|
**Description**
| | :- | :- | -| `` | Path to a resource JSON file. This file is created as a result of the
[`files upload`](/cli/commands/files/upload) command. | +| `` | Path to a resource JSON file. This file is created as a result of the
[`files upload`](/archive/cli/commands/files/upload) command. | | `` | Path to save the downloaded files. | ## Options |
**Name**
|
**Description**
| | :- | :- | -| `--use-addon` | Option required to download files that were [uploaded](/cli/commands/files/upload) with this option. | +| `--use-addon` | Option required to download files that were [uploaded](/archive/cli/commands/files/upload) with this option. | | `--config ` | Path to the SPCTL configuration file.
Default: `./config.json`. | | `--help`, `-h` | Help for the command. | diff --git a/docs/archive/cli/commands/files/index.md b/docs/archive/cli/commands/files/index.md new file mode 100644 index 00000000..6ea4752a --- /dev/null +++ b/docs/archive/cli/commands/files/index.md @@ -0,0 +1,18 @@ +--- +id: "cli-files" +title: "files" +slug: "/cli/commands/files" +sidebar_position: 2 + +--- + +This group contains commands to manage files in third-party storage such as Storj. + +## Commands + +|
**Command**
|
**Description**
| +| :- | :- | +| [files upload](/archive/cli/commands/files/upload) | Encrypts and uploads a file to remote storage. | +| [files calculate-hash](/archive/cli/commands/files/calculate-hash) | Calculates the hash of a file or directory. | +| [files download](/archive/cli/commands/files/download) | Downloads and decrypts a file from remote storage. | +| [files delete](/archive/cli/commands/files/delete) | Deletes a file in remote storage. | \ No newline at end of file diff --git a/docs/cli/commands/files/upload.md b/docs/archive/cli/commands/files/upload.md similarity index 88% rename from docs/cli/commands/files/upload.md rename to docs/archive/cli/commands/files/upload.md index e79f0154..9cb28cae 100644 --- a/docs/cli/commands/files/upload.md +++ b/docs/archive/cli/commands/files/upload.md @@ -1,14 +1,14 @@ --- id: "cli-files-upload" title: "files upload" -slug: "/commands/files/upload" +slug: "/cli/commands/files/upload" sidebar_label: "upload" sidebar_position: 1 --- Uploads files to remote storage such as Storj. -The primary purpose of this command is to make uploaded files available for download and execution inside a CVM. The uploaded data is automatically encrypted and placed in the [storage configured](/cli#set-up-storj-access-optional) in the SPCTL's `config.json` file. If no storage was preconfigured, a free space of up to 20 GB will be automatically created using the Super Protocol's Storj account. +The primary purpose of this command is to make uploaded files available for download and execution inside a CVM. The uploaded data is automatically encrypted and placed in the [storage configured](/archive/cli#set-up-storj-access-optional) in the SPCTL's `config.json` file. If no storage was preconfigured, a free space of up to 20 GB will be automatically created using the Super Protocol's Storj account. The input of the command can be a TAR.GZ file or a directory (with the `--use-addon` flag). @@ -43,7 +43,7 @@ The output of the command is a resource JSON file with the information for the C | `--skip-encryption` | Flag for skipping file encryption before uploading.
Default: `false`. | | `--metadata ` | Path to a metadata JSON file for adding fields to the resource JSON file. | | `--max-concurrent ` | Maximum concurrent pieces to upload at once per transfer to limit the number of threads. Use only when dealing with a memory-constrained environment. | -| `--use-addon` | Flag for uploading a directory instead of a single TAR.GZ archive.
To manage the data uploaded this way, use this option with the [`files delete`](/cli/commands/files/delete) and [`files download`](/cli/commands/files/download) commands. | +| `--use-addon` | Flag for uploading a directory instead of a single TAR.GZ archive.
To manage the data uploaded this way, use this option with the [`files delete`](/archive/cli/commands/files/delete) and [`files download`](/archive/cli/commands/files/download) commands. | | `--config ` | Path to the SPCTL configuration file.
Default: `./config.json`. | | `--help`, `-h` | Help for the command. | diff --git a/docs/archive/cli/commands/index.md b/docs/archive/cli/commands/index.md new file mode 100644 index 00000000..f3e7220e --- /dev/null +++ b/docs/archive/cli/commands/index.md @@ -0,0 +1,19 @@ +--- +id: "cli-commands" +title: "CLI Commands" +slug: "/cli/commands" +sidebar_position: 99 +--- + +This section contains Super Protocol CLI commands. [Install and configure SPCTL](/archive/cli) to access the CLI. + +## Command groups + +|
**Group**
|
**Description**
| +| :- | :- | +| [tokens](/archive/cli/commands/tokens) | Receive SPPI and BNB test tokens; **testnet only**. | +| [files](/archive/cli/commands/files) | Manage files in decentralized storage. | +| [workflows](/archive/cli/commands/workflows) | Create a new order. | +| [orders](/archive/cli/commands/orders) | Manage your orders. | +| [providers](/archive/cli/commands/providers) | View and manage providers. | +| [offers](/archive/cli/commands/offers) | View and manage Marketplace offers. | \ No newline at end of file diff --git a/docs/cli/commands/offers/add-slot.md b/docs/archive/cli/commands/offers/add-slot.md similarity index 91% rename from docs/cli/commands/offers/add-slot.md rename to docs/archive/cli/commands/offers/add-slot.md index dd4ce284..f80ac7ee 100644 --- a/docs/cli/commands/offers/add-slot.md +++ b/docs/archive/cli/commands/offers/add-slot.md @@ -1,14 +1,14 @@ --- id: "cli-offers-add-slot" title: "offers add-slot" -slug: "/commands/offers/add-slot" +slug: "/cli/commands/offers/add-slot" sidebar_label: "add-slot" sidebar_position: 9 --- Adds a slot to an offer. -**Important:** This command requires SPCTL with a [provider configuration file](/cli/guides/provider-tools#providers-spctl). +**Important:** This command requires SPCTL with a [provider configuration file](/archive/cli/guides/provider-tools#providers-spctl). ## Syntax @@ -49,7 +49,7 @@ A slot-info JSON file must contain the following objects: - `maxTimeMinutes`: Maximum lease duration limits in minutes; `0` for no limit. - `minTimeMinutes`: Minimum lease duration limits in minutes; `0` for no limit. - `price`: Lease price in denominations of SPPI token (1018 = 1 SPPI). - - `priceType`: [Pricing type](/fundamentals/orders#cost-and-pricing): `1` for fixed price, `0` for price per hour. + - `priceType`: [Pricing type](/archive/fundamentals/orders#cost-and-pricing): `1` for fixed price, `0` for price per hour. - `option`: An object with internet access requirements (only for value offers): - `bandwidth`: Data transfer rate in bits per second. - `traffic`: Total required data transfer usage in bytes. diff --git a/docs/cli/commands/offers/delete-slot.md b/docs/archive/cli/commands/offers/delete-slot.md similarity index 79% rename from docs/cli/commands/offers/delete-slot.md rename to docs/archive/cli/commands/offers/delete-slot.md index efb0d9e4..19ad823b 100644 --- a/docs/cli/commands/offers/delete-slot.md +++ b/docs/archive/cli/commands/offers/delete-slot.md @@ -1,16 +1,16 @@ --- id: "cli-offers-delete-slot" title: "offers delete-slot" -slug: "/commands/offers/delete-slot" +slug: "/cli/commands/offers/delete-slot" sidebar_label: "delete-slot" sidebar_position: 11 --- Deletes a slot in an offer. -**Important:** This command requires SPCTL with a [provider configuration file](/cli/guides/provider-tools#providers-spctl). +**Important:** This command requires SPCTL with a [provider configuration file](/archive/cli/guides/provider-tools#providers-spctl). -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. +Use the [`offers get`](/archive/cli/commands/offers/get) command to get the IDs of all slots in an offer. Use the [`offers get-slot`](/archive/cli/commands/offers/get-slot) command to get additional information on a slot. ## Syntax diff --git a/docs/cli/commands/offers/disable.md b/docs/archive/cli/commands/offers/disable.md similarity index 90% rename from docs/cli/commands/offers/disable.md rename to docs/archive/cli/commands/offers/disable.md index 274311a6..a6ae3c52 100644 --- a/docs/cli/commands/offers/disable.md +++ b/docs/archive/cli/commands/offers/disable.md @@ -1,14 +1,14 @@ --- id: "cli-offers-disable" title: "offers disable" -slug: "/commands/offers/disable" +slug: "/cli/commands/offers/disable" sidebar_label: "disable" sidebar_position: 6 --- Disables an existing enabled offer. -**Important:** This command requires SPCTL with a [provider configuration file](/cli/guides/provider-tools#providers-spctl). +**Important:** This command requires SPCTL with a [provider configuration file](/archive/cli/guides/provider-tools#providers-spctl). ## Syntax diff --git a/docs/cli/commands/offers/download-content.md b/docs/archive/cli/commands/offers/download-content.md similarity index 96% rename from docs/cli/commands/offers/download-content.md rename to docs/archive/cli/commands/offers/download-content.md index a34fac1f..03c9b24e 100644 --- a/docs/cli/commands/offers/download-content.md +++ b/docs/archive/cli/commands/offers/download-content.md @@ -1,7 +1,7 @@ --- id: "cli-offers-download-content" title: "offers download-content" -slug: "/commands/offers/download-content" +slug: "/cli/commands/offers/download-content" sidebar_label: "download-content" sidebar_position: 4 --- diff --git a/docs/cli/commands/offers/enable.md b/docs/archive/cli/commands/offers/enable.md similarity index 90% rename from docs/cli/commands/offers/enable.md rename to docs/archive/cli/commands/offers/enable.md index 88586e91..0704c579 100644 --- a/docs/cli/commands/offers/enable.md +++ b/docs/archive/cli/commands/offers/enable.md @@ -1,14 +1,14 @@ --- id: "cli-offers-enable" title: "offers enable" -slug: "/commands/offers/enable" +slug: "/cli/commands/offers/enable" sidebar_label: "enable" sidebar_position: 7 --- Enables an existing disabled offer. -**Important:** This command requires SPCTL with a [provider configuration file](/cli/guides/provider-tools#providers-spctl). +**Important:** This command requires SPCTL with a [provider configuration file](/archive/cli/guides/provider-tools#providers-spctl). ## Syntax diff --git a/docs/cli/commands/offers/get-info.md b/docs/archive/cli/commands/offers/get-info.md similarity index 97% rename from docs/cli/commands/offers/get-info.md rename to docs/archive/cli/commands/offers/get-info.md index caeb9fca..69514eee 100644 --- a/docs/cli/commands/offers/get-info.md +++ b/docs/archive/cli/commands/offers/get-info.md @@ -1,7 +1,7 @@ --- id: "cli-offers-get-info" title: "offers get-info" -slug: "/commands/offers/get-info" +slug: "/cli/commands/offers/get-info" sidebar_label: "get-info" sidebar_position: 3 --- diff --git a/docs/cli/commands/offers/get-option.md b/docs/archive/cli/commands/offers/get-option.md similarity index 80% rename from docs/cli/commands/offers/get-option.md rename to docs/archive/cli/commands/offers/get-option.md index 8818c41d..c7bb47a2 100644 --- a/docs/cli/commands/offers/get-option.md +++ b/docs/archive/cli/commands/offers/get-option.md @@ -1,12 +1,12 @@ --- id: "cli-offers-get-option" title: "offers get-option" -slug: "/commands/offers/get-option" +slug: "/cli/commands/offers/get-option" sidebar_label: "get-option" sidebar_position: 12 --- -Displays the information on a [configuration option](/fundamentals/slots) of a compute offer. +Displays the information on a [configuration option](/archive/fundamentals/slots) of a compute offer. ## Syntax diff --git a/docs/cli/commands/offers/get-slot.md b/docs/archive/cli/commands/offers/get-slot.md similarity index 90% rename from docs/cli/commands/offers/get-slot.md rename to docs/archive/cli/commands/offers/get-slot.md index fa0061f2..c677e37c 100644 --- a/docs/cli/commands/offers/get-slot.md +++ b/docs/archive/cli/commands/offers/get-slot.md @@ -1,14 +1,14 @@ --- id: "cli-offers-get-slot" title: "offers get-slot" -slug: "/commands/offers/get-slot" +slug: "/cli/commands/offers/get-slot" sidebar_label: "get-slot" sidebar_position: 8 --- Displays the information for a slot in an offer. -Use the [`offers get`](/cli/commands/offers/get) command to get the IDs of all the offer's slots. +Use the [`offers get`](/archive/cli/commands/offers/get) command to get the IDs of all the offer's slots. ## Syntax diff --git a/docs/cli/commands/offers/get.md b/docs/archive/cli/commands/offers/get.md similarity index 97% rename from docs/cli/commands/offers/get.md rename to docs/archive/cli/commands/offers/get.md index 221bdd7a..68c56a8d 100644 --- a/docs/cli/commands/offers/get.md +++ b/docs/archive/cli/commands/offers/get.md @@ -1,7 +1,7 @@ --- id: "cli-offers-get" title: "offers get" -slug: "/commands/offers/get" +slug: "/cli/commands/offers/get" sidebar_label: "get" sidebar_position: 2 --- diff --git a/docs/archive/cli/commands/offers/index.md b/docs/archive/cli/commands/offers/index.md new file mode 100644 index 00000000..14662a07 --- /dev/null +++ b/docs/archive/cli/commands/offers/index.md @@ -0,0 +1,38 @@ +--- +id: "cli-offers" +title: "offers" +slug: "/cli/commands/offers" +sidebar_position: 6 + +--- + +This group contains commands to view and manage offers. + +## Commands + +|
**Command**
|
**Description**
| +| :- | :- | +| [offers list](/archive/cli/commands/offers/list) | Lists available offers. | +| [offers get](/archive/cli/commands/offers/get) | Displays information on an offer. | +| [offers get-info](/archive/cli/commands/offers/get-info) | Displays information on an offer as stored on the blockchain. | +| [offers download-content](/archive/cli/commands/offers/download-content) | Downloads the content of an offer. | +| [offers update](/archive/cli/commands/offers/update) | Updates an offer. | +| [offers disable](/archive/cli/commands/offers/disable) | Disables an enabled offer. | +| [offers enable](/archive/cli/commands/offers/enable) | Enables a disabled offer. | + +### Slot-related commands + +|
**Command**
|
**Description**
| +| :- | :- | +| [offers get-slot](/archive/cli/commands/offers/get-slot) | Displays information on a slot. | +| [offers add-slot](/archive/cli/commands/offers/add-slot) | Adds a new slot to an existing offer. | +| [offers update-slot](/archive/cli/commands/offers/update-slot) | Updates a slot. | +| [offers delete-slot](/archive/cli/commands/offers/delete-slot) | Deletes a slot. | + +### Option-related command + +This command only works with compute offers. + +|
**Command**
|
**Description**
| +| :- | :- | +| [offers get-option](/archive/cli/commands/offers/get-option) | Displays information for an option. | diff --git a/docs/cli/commands/offers/list.md b/docs/archive/cli/commands/offers/list.md similarity index 98% rename from docs/cli/commands/offers/list.md rename to docs/archive/cli/commands/offers/list.md index 6d14216b..77aaaae5 100644 --- a/docs/cli/commands/offers/list.md +++ b/docs/archive/cli/commands/offers/list.md @@ -1,7 +1,7 @@ --- id: "cli-offers-list" title: "offers list" -slug: "/commands/offers/list" +slug: "/cli/commands/offers/list" sidebar_label: "list" sidebar_position: 1 --- diff --git a/docs/cli/commands/offers/update-slot.md b/docs/archive/cli/commands/offers/update-slot.md similarity index 73% rename from docs/cli/commands/offers/update-slot.md rename to docs/archive/cli/commands/offers/update-slot.md index b9959301..6ede4a2e 100644 --- a/docs/cli/commands/offers/update-slot.md +++ b/docs/archive/cli/commands/offers/update-slot.md @@ -1,18 +1,18 @@ --- id: "cli-offers-update-slot" title: "offers update-slot" -slug: "/commands/offers/update-slot" +slug: "/cli/commands/offers/update-slot" sidebar_label: "update-slot" sidebar_position: 10 --- Updates a slot in an offer. -**Important:** This command requires SPCTL with a [provider configuration file](/cli/guides/provider-tools#providers-spctl). +**Important:** This command requires SPCTL with a [provider configuration file](/archive/cli/guides/provider-tools#providers-spctl). -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. +Use the [`offers get`](/archive/cli/commands/offers/get) command to get the IDs of all slots in an offer. Use the [`offers get-slot`](/archive/cli/commands/offers/get-slot) command to get additional information on a slot. -Refer to the description of the [`offers add-slot`](/cli/commands/offers/add-slot) command for the slotInfo JSON file format and object descriptions and to create the initial offer requirements. +Refer to the description of the [`offers add-slot`](/archive/cli/commands/offers/add-slot) command for the slotInfo JSON file format and object descriptions and to create the initial offer requirements. ## Syntax diff --git a/docs/cli/commands/offers/update.md b/docs/archive/cli/commands/offers/update.md similarity index 95% rename from docs/cli/commands/offers/update.md rename to docs/archive/cli/commands/offers/update.md index 501a7acc..2e705ce3 100644 --- a/docs/cli/commands/offers/update.md +++ b/docs/archive/cli/commands/offers/update.md @@ -1,14 +1,14 @@ --- id: "cli-offers-update" title: "offers update" -slug: "/commands/offers/update" +slug: "/cli/commands/offers/update" sidebar_label: "update" sidebar_position: 5 --- Updates information about an offer. -**Important:** This command requires SPCTL with a [provider configuration file](/cli/guides/provider-tools#providers-spctl). +**Important:** This command requires SPCTL with a [provider configuration file](/archive/cli/guides/provider-tools#providers-spctl). ## Syntax @@ -52,7 +52,7 @@ The offer-info JSON file may contain the following objects, arrays, and strings, | `argsPublicKey` | Encryption information in a string format:
`algo`: algorithm for encrypting arguments
`encoding`: encoding scheme
`key`: public key. | Template:
`"argsPublicKey":`
`"{\"algo\":\"ECIES\",`
`\"encoding\":\"base64\",`
`\"key\":\"\"}"`

Replace `` with a public key. | | `resultResource` | Unencrypted content available for downloading, in a string format:
`type`, `storageType`, `credentials` to access content, including `token`, `storageId`, and `filepath`.

It is mainly used for base image solutions.| Template:
`"resultResource":`
`"{\"type\":\"STORAGE_PROVIDER\",`
`\"storageType\":\"STORJ\",`
`\"credentials\":`
`{\"token\":\"\",`
`\"storageId\":\"\"},`
`\"filepath\":\"\"}"`

Use `STORAGE_PROVIDER` for `type` and `STORJ` for `storageType` (currently, only Storj is supported). Replace: `` with a Storj access grant with **Read** permission, `` with the bucket name, and `` with the path to the file in the bucket. | -Use the [`offers get-info`](/cli/commands/offers/get-info) command to get the offer-info of an existing offer to use as an example. +Use the [`offers get-info`](/archive/cli/commands/offers/get-info) command to get the offer-info of an existing offer to use as an example. The file you prepare should contain only the fields that need to be updated. For example, to only update the `name` and `description` fields, the file should look like this: diff --git a/docs/cli/commands/orders/cancel.md b/docs/archive/cli/commands/orders/cancel.md similarity index 96% rename from docs/cli/commands/orders/cancel.md rename to docs/archive/cli/commands/orders/cancel.md index 29455e98..e0627bf5 100644 --- a/docs/cli/commands/orders/cancel.md +++ b/docs/archive/cli/commands/orders/cancel.md @@ -1,7 +1,7 @@ --- id: "cli-orders-cancel" title: "orders cancel" -slug: "/commands/orders/cancel" +slug: "/cli/commands/orders/cancel" sidebar_label: "cancel" sidebar_position: 4 --- diff --git a/docs/cli/commands/orders/complete.md b/docs/archive/cli/commands/orders/complete.md similarity index 97% rename from docs/cli/commands/orders/complete.md rename to docs/archive/cli/commands/orders/complete.md index 05dcefe1..b3a4cb5e 100644 --- a/docs/cli/commands/orders/complete.md +++ b/docs/archive/cli/commands/orders/complete.md @@ -1,7 +1,7 @@ --- id: "cli-orders-complete" title: "orders complete" -slug: "/commands/orders/complete" +slug: "/cli/commands/orders/complete" sidebar_label: "complete" sidebar_position: 6 --- diff --git a/docs/cli/commands/orders/download-result.md b/docs/archive/cli/commands/orders/download-result.md similarity index 96% rename from docs/cli/commands/orders/download-result.md rename to docs/archive/cli/commands/orders/download-result.md index 9fa5880d..f65ae1ba 100644 --- a/docs/cli/commands/orders/download-result.md +++ b/docs/archive/cli/commands/orders/download-result.md @@ -1,7 +1,7 @@ --- id: "cli-orders-download-result" title: "orders download-result" -slug: "/commands/orders/download-result" +slug: "/cli/commands/orders/download-result" sidebar_label: "download-result" sidebar_position: 5 --- diff --git a/docs/cli/commands/orders/get-report.md b/docs/archive/cli/commands/orders/get-report.md similarity index 96% rename from docs/cli/commands/orders/get-report.md rename to docs/archive/cli/commands/orders/get-report.md index d9d4af39..1f8c2c6b 100644 --- a/docs/cli/commands/orders/get-report.md +++ b/docs/archive/cli/commands/orders/get-report.md @@ -1,7 +1,7 @@ --- id: "cli-orders-get-report" title: "orders get-report" -slug: "/commands/orders/get-report" +slug: "/cli/commands/orders/get-report" sidebar_label: "get-report" sidebar_position: 7 --- diff --git a/docs/cli/commands/orders/get.md b/docs/archive/cli/commands/orders/get.md similarity index 98% rename from docs/cli/commands/orders/get.md rename to docs/archive/cli/commands/orders/get.md index bb997769..1450d0d1 100644 --- a/docs/cli/commands/orders/get.md +++ b/docs/archive/cli/commands/orders/get.md @@ -1,7 +1,7 @@ --- id: "cli-orders-get" title: "orders get" -slug: "/commands/orders/get" +slug: "/cli/commands/orders/get" sidebar_label: "get" sidebar_position: 2 --- diff --git a/docs/archive/cli/commands/orders/index.md b/docs/archive/cli/commands/orders/index.md new file mode 100644 index 00000000..8ca17695 --- /dev/null +++ b/docs/archive/cli/commands/orders/index.md @@ -0,0 +1,21 @@ +--- +id: "cli-orders" +title: "orders" +slug: "/cli/commands/orders" +sidebar_position: 4 + +--- + +This group contains commands to track and manage orders. Note that [Marketplace web app](https://marketplace.superprotocol.com/marketplace) may be more convenient to use than most of the commands in this group. + +## Commands + +|
**Command**
|
**Description**
| +| :- | :- | +| [orders list](/archive/cli/commands/orders/list) | Lists orders. | +| [orders get](/archive/cli/commands/orders/get) | Displays information on an order. | +| [orders replenish-deposit](/archive/cli/commands/orders/replenish-deposit) | Replenishes the order deposit. | +| [orders cancel](/archive/cli/commands/orders/cancel) | Cancels an order. | +| [orders download-result](/archive/cli/commands/orders/download-result) | Downloads the order result. | +| [orders complete](/archive/cli/commands/orders/complete) | Completes an order. | +| [orders get-report](/archive/cli/commands/orders/get-report) | Downloads the order report. | \ No newline at end of file diff --git a/docs/cli/commands/orders/list.md b/docs/archive/cli/commands/orders/list.md similarity index 98% rename from docs/cli/commands/orders/list.md rename to docs/archive/cli/commands/orders/list.md index 681f2ab8..3b88f34b 100644 --- a/docs/cli/commands/orders/list.md +++ b/docs/archive/cli/commands/orders/list.md @@ -1,7 +1,7 @@ --- id: "cli-orders-list" title: "orders list" -slug: "/commands/orders/list" +slug: "/cli/commands/orders/list" sidebar_label: "list" sidebar_position: 1 --- diff --git a/docs/cli/commands/orders/replenish-deposit.md b/docs/archive/cli/commands/orders/replenish-deposit.md similarity index 95% rename from docs/cli/commands/orders/replenish-deposit.md rename to docs/archive/cli/commands/orders/replenish-deposit.md index 8343badb..00643e77 100644 --- a/docs/cli/commands/orders/replenish-deposit.md +++ b/docs/archive/cli/commands/orders/replenish-deposit.md @@ -1,7 +1,7 @@ --- id: "cli-orders-replenish-deposit" title: "orders replenish-deposit" -slug: "/commands/orders/replenish-deposit" +slug: "/cli/commands/orders/replenish-deposit" sidebar_label: "replenish-deposit" sidebar_position: 3 --- diff --git a/docs/cli/commands/providers/get.md b/docs/archive/cli/commands/providers/get.md similarity index 97% rename from docs/cli/commands/providers/get.md rename to docs/archive/cli/commands/providers/get.md index 17cb89f6..5d7360ed 100644 --- a/docs/cli/commands/providers/get.md +++ b/docs/archive/cli/commands/providers/get.md @@ -1,7 +1,7 @@ --- id: "cli-providers-get" title: "providers get" -slug: "/commands/providers/get" +slug: "/cli/commands/providers/get" sidebar_label: "get" sidebar_position: 1 --- diff --git a/docs/archive/cli/commands/providers/index.md b/docs/archive/cli/commands/providers/index.md new file mode 100644 index 00000000..85c2933d --- /dev/null +++ b/docs/archive/cli/commands/providers/index.md @@ -0,0 +1,17 @@ +--- +id: "cli-providers" +title: "providers" +slug: "/cli/commands/providers" +sidebar_position: 5 + +--- + +This group contains commands to view and update [providers](/archive/fundamentals/offers). + +## Commands + +|
**Command**
|
**Description**
| +| :- | :- | +| [providers get](/archive/cli/commands/providers/get) | Displays information on a provider using its authority account address. | +| [providers update](/archive/cli/commands/providers/update) | Updates the current provider information. | +| [providers list](/archive/cli/commands/providers/list) | Lists all providers. | \ No newline at end of file diff --git a/docs/cli/commands/providers/list.md b/docs/archive/cli/commands/providers/list.md similarity index 97% rename from docs/cli/commands/providers/list.md rename to docs/archive/cli/commands/providers/list.md index 7899af4f..c55896f5 100644 --- a/docs/cli/commands/providers/list.md +++ b/docs/archive/cli/commands/providers/list.md @@ -1,7 +1,7 @@ --- id: "cli-providers-list" title: "providers list" -slug: "/commands/providers/list" +slug: "/cli/commands/providers/list" sidebar_label: "list" sidebar_position: 2 --- diff --git a/docs/cli/commands/providers/update.md b/docs/archive/cli/commands/providers/update.md similarity index 94% rename from docs/cli/commands/providers/update.md rename to docs/archive/cli/commands/providers/update.md index 8b57c044..68a00550 100644 --- a/docs/cli/commands/providers/update.md +++ b/docs/archive/cli/commands/providers/update.md @@ -1,14 +1,14 @@ --- id: "cli-providers-update" title: "providers update" -slug: "/commands/providers/update" +slug: "/cli/commands/providers/update" sidebar_label: "update" sidebar_position: 3 --- Updates information about a provider. -**Important:** This command requires SPCTL with a [provider configuration file](/cli/guides/provider-tools#providers-spctl). +**Important:** This command requires SPCTL with a [provider configuration file](/archive/cli/guides/provider-tools#providers-spctl). ## Syntax diff --git a/docs/cli/commands/syntax.md b/docs/archive/cli/commands/syntax.md similarity index 83% rename from docs/cli/commands/syntax.md rename to docs/archive/cli/commands/syntax.md index 877a52d7..42ba52d3 100644 --- a/docs/cli/commands/syntax.md +++ b/docs/archive/cli/commands/syntax.md @@ -1,7 +1,7 @@ --- id: "syntax" title: "Command Syntax" -slug: "/syntax" +slug: "/cli/syntax" sidebar_position: 1 --- @@ -11,16 +11,16 @@ Command format: ./spctl ``` -_Command groups_ contain functionally related commands. See the [full list of command groups](/cli/commands). +_Command groups_ contain functionally related commands. See the [full list of command groups](/archive/cli/commands). _Commands_ perform a specific function, like placing an order or showing the list of providers. -For example, the [`files`](/cli/commands/files) command group includes the following commands: +For example, the [`files`](/archive/cli/commands/files) command group includes the following commands: -- [`upload`](/cli/commands/files/upload) -- [`calculate-hash`](/cli/commands/files/calculate-hash) -- [`download`](/cli/commands/files/download) -- [`delete`](/cli/commands/files/delete) +- [`upload`](/archive/cli/commands/files/upload) +- [`calculate-hash`](/archive/cli/commands/files/calculate-hash) +- [`download`](/archive/cli/commands/files/download) +- [`delete`](/archive/cli/commands/files/delete) _Options_ modify the command behavior and are prefixed by double hyphen `--`; for example, `--help`. Options can be mandatory or optional. @@ -37,7 +37,7 @@ Never include these special characters in the final command. ### Example -The following is a mandatory option `--solution` of the [`workflows create`](/cli/commands/workflows/create) command: +The following is a mandatory option `--solution` of the [`workflows create`](/archive/cli/commands/workflows/create) command: ``` --solution {[,] | } diff --git a/docs/cli/commands/tokens/balance.md b/docs/archive/cli/commands/tokens/balance.md similarity index 94% rename from docs/cli/commands/tokens/balance.md rename to docs/archive/cli/commands/tokens/balance.md index 4c7990c0..501438f8 100644 --- a/docs/cli/commands/tokens/balance.md +++ b/docs/archive/cli/commands/tokens/balance.md @@ -1,7 +1,7 @@ --- id: "cli-tokens-balance" title: "tokens balance" -slug: "/commands/tokens/balance" +slug: "/cli/commands/tokens/balance" sidebar_label: "balance" --- diff --git a/docs/cli/commands/tokens/index.md b/docs/archive/cli/commands/tokens/index.md similarity index 80% rename from docs/cli/commands/tokens/index.md rename to docs/archive/cli/commands/tokens/index.md index 2835e1d5..260a9b82 100644 --- a/docs/cli/commands/tokens/index.md +++ b/docs/archive/cli/commands/tokens/index.md @@ -1,7 +1,7 @@ --- id: "cli-tokens" title: "tokens" -slug: "/commands/tokens" +slug: "/cli/commands/tokens" sidebar_position: 1 --- @@ -13,4 +13,4 @@ SPPI tokens are necessary to pay for order and necessary suborders: solution, data, and storage. -The output of the command contains the order ID necessary to track and manage the order with the [`orders`](/cli/commands/orders) commands or in the [Marketplace web app](https://marketplace.superprotocol.com/marketplace). +The output of the command contains the order ID necessary to track and manage the order with the [`orders`](/archive/cli/commands/orders) commands or in the [Marketplace web app](https://marketplace.superprotocol.com/marketplace). -For solutions and data, you can add to an order either a Marketplace offer or [uploaded files](/cli/commands/files/upload). Refer to the [fundamentals](/fundamentals) to understand the logic of the Super Protocol order creation process. +For solutions and data, you can add to an order either a Marketplace offer or [uploaded files](/archive/cli/commands/files/upload). Refer to the [fundamentals](/archive/fundamentals) to understand the logic of the Super Protocol order creation process. ## Syntax @@ -34,16 +34,16 @@ For solutions and |
**Name**
|
**Description**
| | :- | :- | -| `--tee [,]` | Compute offer you are adding to the order. State the compute offer ID and, optionally, the [configuration slot](/fundamentals/slots#configuration) ID, separated by a comma. If the configuration slot is not specified, it will be selected automatically.

If you do not use this option, the compute offer and its configuration will be selected automatically. | +| `--tee [,]` | Compute offer you are adding to the order. State the compute offer ID and, optionally, the [configuration slot](/archive/fundamentals/slots#configuration) ID, separated by a comma. If the configuration slot is not specified, it will be selected automatically.

If you do not use this option, the compute offer and its configuration will be selected automatically. | | `--tee-slot-count ` | Configuration slot increments—how many times the selected slot is applied. Use this option together with `--tee`.

If you do not use this option, the increments will be calculated automatically. | -| `--tee-options