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
4 changes: 2 additions & 2 deletions docs/cli/commands/files/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The resource JSON file is created as a result of the [`files upload`](/cli/comma
## Syntax

```
./spctl files delete <resourceFilePath> \
[--config <path>] \
./spctl files delete <resourceFilePath>
[--config <path>]
[--help | -h]
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/files/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The resource JSON file is created as a result of the [`files upload`](/cli/comma
## Syntax

```
./spctl files download <resourceFilePath> <saveToPath> \
[--config <path>] \
./spctl files download <resourceFilePath> <saveToPath>
[--config <path>]
[--help | -h]
```

Expand Down
18 changes: 9 additions & 9 deletions docs/cli/commands/files/upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ The output of the command is a resource JSON file with the information for a com
## Syntax

```
./spctl files upload <targzArchivePath> \
[--filename <string>] \
[--output <path>] \
[--skip-encryption] \
[--metadata <path>] \
[--max-concurrent <number>] \
[--storage <offerId,slotId>] \
[--min-rent-minutes <minutes>] \
[--config <path>] \
./spctl files upload <targzArchivePath>
[--filename <string>]
[--output <path>]
[--skip-encryption]
[--metadata <path>]
[--max-concurrent <number>]
[--storage <offerId,slotId>]
[--min-rent-minutes <minutes>]
[--config <path>]
[--help | -h]
```

Expand Down
3 changes: 1 addition & 2 deletions docs/cli/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,8 @@ Command syntax may also contain the following special characters:
- Curly brackets `{ }` indicate a required choice between two or more options or arguments.
- A vertical bar `|` separates mutually exclusive options or arguments you must choose from.
- An ellipsis `...` indicates you may use the preceding option or argument multiple times.
- A backslash `\` breaks a long command line for better readability.

Never include these special characters, except backslash `\`, in the final command. Do not include backslashes `\` if you type a command in a single line.
Never include these special characters in the final command.

### Example

Expand Down
8 changes: 4 additions & 4 deletions docs/cli/commands/offers/add-slot.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Refer to the [Providers and Offers] guide to create the initial offer requiremen
## Syntax

```
./spctl offers add-slot <offerType> \
--offer <offerId> \
[--path <path>] \
[--config <path>] \
./spctl offers add-slot <offerType>
--offer <offerId>
[--path <path>]
[--config <path>]
[--help | -h]
```

Expand Down
8 changes: 4 additions & 4 deletions docs/cli/commands/offers/delete-slot.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Use the [`offers get`](/cli/commands/offers/get) command to get the IDs of all s
## Syntax

```
./spctl offers delete-slot <offerType> \
--offer <offerId> \
--slot <slotId> \
[--config <path>] \
./spctl offers delete-slot <offerType>
--offer <offerId>
--slot <slotId>
[--config <path>]
[--help | -h]
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/offers/disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Disables an existing enabled offer.
## Syntax

```
./spctl offers disable <offerId> \
[--config <path>] \
./spctl offers disable <offerId>
[--config <path>]
[--help | -h]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/offers/download-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ The command only works with offers that allow this operation.
## Syntax

```
./spctl offers download-content <offerId> \
[--save-to <path>] \
[--config <path>] \
./spctl offers download-content <offerId>
[--save-to <path>]
[--config <path>]
[--help | -h]
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/offers/enable.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Enables an existing disabled offer.
## Syntax

```
./spctl offers enable <offerId> \
[--config <path>] \
./spctl offers enable <offerId>
[--config <path>]
[--help | -h]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/offers/get-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Displays the information on an offer as stored on the blockchain.
## Syntax

```
./spctl offers get-info <offerType> <offerId> \
[--save-to <path>] \
[--config <path>] \
./spctl offers get-info <offerType> <offerId>
[--save-to <path>]
[--config <path>]
[--help | -h]
```

Expand Down
8 changes: 4 additions & 4 deletions docs/cli/commands/offers/get-option.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ Displays the information on a [configuration option](/fundamentals/slots) of a c
## Syntax

```
./spctl offers get-option \
--offer <offerId> \
--option <optionId> \
[--config <path>] \
./spctl offers get-option
--offer <offerId>
--option <optionId>
[--config <path>]
[--help | -h]
```

Expand Down
10 changes: 5 additions & 5 deletions docs/cli/commands/offers/get-slot.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Use the [`offers get`](/cli/commands/offers/get) command to get the IDs of all s
## Syntax

```
./spctl offers get-slot <offerType> \
--offer <offerId> \
--slot <slotId> \
[--save-to <path>] \
[--config <path>] \
./spctl offers get-slot <offerType>
--offer <offerId>
--slot <slotId>
[--save-to <path>]
[--config <path>]
[--help | -h]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/offers/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Displays information on an offer.
## Syntax

```
./spctl offers get <offerType> <offerId> \
[--save-to <path>] \
[--config <path>] \
./spctl offers get <offerType> <offerId>
[--save-to <path>]
[--config <path>]
[--help | -h]
```

Expand Down
12 changes: 6 additions & 6 deletions docs/cli/commands/offers/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Displays a list of available offers.
## Syntax

```
./spctl offers list <offerType> \
[--fields <field>,[<field>,...]] \
[--ids <offerId> [<offerId> ...]] \
[--limit <number>] \
[--cursor <cursorString>] \
[--config <path>] \
./spctl offers list <offerType>
[--fields <field>,[<field>,...]]
[--ids <offerId> [<offerId> ...]]
[--limit <number>]
[--cursor <cursorString>]
[--config <path>]
[--help | -h]
```

Expand Down
10 changes: 5 additions & 5 deletions docs/cli/commands/offers/update-slot.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ Refer to [Offer requirements] to create the initial offer requirements. Refer to
## Syntax

```
./spctl offers update-slot <offerType> \
--offer <offerId> \
--slot <slotId> \
[--path <path>] \
[--config <path>] \
./spctl offers update-slot <offerType>
--offer <offerId>
--slot <slotId>
[--path <path>]
[--config <path>]
[--help | -h]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/offers/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Refer to the [Providers and Offers] guide to create the initial offer descriptio
## Syntax

```
./spctl offers update <offerType> <offerId> \
[--path <path>] \
[--config <path>] \
./spctl offers update <offerType> <offerId>
[--path <path>]
[--config <path>]
[--help | -h]
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/orders/cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Cancels an order.
## Syntax

```
./spctl orders cancel <orderId> \
[--config <path>] \
./spctl orders cancel <orderId>
[--config <path>]
[--help | -h]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/orders/download-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ If the order status is `Error`, the result archive will contain a text file with
## Syntax

```
./spctl orders download-result <orderId> \
[--save-to <path>] \
[--config <path>] \
./spctl orders download-result <orderId>
[--save-to <path>]
[--config <path>]
[--help | -h]
```

Expand Down
10 changes: 5 additions & 5 deletions docs/cli/commands/orders/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ This command allows you to check any order, not only yours. The information on a
## Syntax

```
./spctl orders get <orderId> \
[--fields <field>,[<field>,...]] \
[--suborders] \
[--suborders_fields <field>,[<field>,...]] \
[--config <path>] \
./spctl orders get <orderId>
[--fields <field>,[<field>,...]]
[--suborders]
[--suborders_fields <field>,[<field>,...]]
[--config <path>]
[--help | -h]
```

Expand Down
16 changes: 8 additions & 8 deletions docs/cli/commands/orders/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ This command displays a list of all orders and suborders, unless the `--my-accou
## Syntax

```
./spctl orders list \
[--fields <field>,[<field>,...]] \
[--my-account] \
[--type {tee | storage | solution | data}] \
[--save-to <path>] \
[--limit <number>] \
[--cursor <cursorString>] \
[--config <path>] \
./spctl orders list
[--fields <field>,[<field>,...]]
[--my-account]
[--type {tee | storage | solution | data}]
[--save-to <path>]
[--limit <number>]
[--cursor <cursorString>]
[--config <path>]
[--help | -h]
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/orders/replenish-deposit.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Certain orders require a positive deposit balance to keep running.
## Syntax

```
./spctl orders replenish-deposit <orderId> <tokenAmount> \
[--config <path>] \
./spctl orders replenish-deposit <orderId> <tokenAmount>
[--config <path>]
[--help | -h]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/providers/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Displays the information on a provider using its authority account address.
## Syntax

```
./spctl providers get <authorityAccount> \
[--fields <field>,[<field>,...]] \
[--config <path>] \
./spctl providers get <authorityAccount>
[--fields <field>,[<field>,...]]
[--config <path>]
[--help | -h]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/providers/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Lists all registered providers.
## Syntax

```
./spctl providers list \
[--fields <field>,[<field>,...]] \
[--config <path>] \
./spctl providers list
[--fields <field>,[<field>,...]]
[--config <path>]
[--help | -h]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/providers/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Provider Tools creates a provider info JSON file in [Step 4 of the Providers and
## Syntax

```
./spctl providers update \
[--path <path>] \
[--config <path>] \
./spctl providers update
[--path <path>]
[--config <path>]
[--help | -h]
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/quotes/validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Checks if the domain content runs in a confidential environment. The command als
## Syntax

```
./spctl quotes validate <domainUrl> \
[--config <path>] \
./spctl quotes validate <domainUrl>
[--config <path>]
[--help | -h]
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/solutions/generate-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Docker needs this key to [pack a solution](/cli/commands/solutions/prepare) into
## Syntax

```
./spctl solutions generate-key <outputPath> \
[--config <path>] \
./spctl solutions generate-key <outputPath>
[--config <path>]
[--help | -h]
```

Expand Down
24 changes: 12 additions & 12 deletions docs/cli/commands/solutions/prepare.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,18 @@ Note that the base image is graminized but not included in the output archive fi
## Syntax

```
./spctl solutions prepare <solutionPath> <signingKeyPath> \
[--base-image-path <path>] \
[--metadata <path>] \
[--pack-solution <path>] \
[--write-default-manifest] \
[--env <envVariable> [--env ...]] \
[--hash-algo <hashAlgo>] \
[--sgx-max-threads <number>] \
[--sgx-enclave-size <number>] \
[--sgx-loader-internal-size <number>] \
[--sgx-stack-size <number>] \
[--config <path>] \
./spctl solutions prepare <solutionPath> <signingKeyPath>
[--base-image-path <path>]
[--metadata <path>]
[--pack-solution <path>]
[--write-default-manifest]
[--env <envVariable> [--env ...]]
[--hash-algo <hashAlgo>]
[--sgx-max-threads <number>]
[--sgx-enclave-size <number>]
[--sgx-loader-internal-size <number>]
[--sgx-stack-size <number>]
[--config <path>]
[--help | -h]
```

Expand Down
Loading
Loading