diff --git a/docs/colab/cli.md b/docs/colab/cli.md index 34d83953..37802cff 100644 --- a/docs/colab/cli.md +++ b/docs/colab/cli.md @@ -8,7 +8,9 @@ sidebar_position: 2 import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Before you begin: Create an account, get tokens, and set up SPCTL +## Before you begin + +### Create an account and get tokens 1. Complete the first two steps of the guide [Log In as a Web3 User](https://docs.superprotocol.com/guides/log-in) (MetaMask is recommended). @@ -24,29 +26,39 @@ import TabItem from '@theme/TabItem';

-4. Save your web3 account private key. +### Set up SPCTL—the Super Protocol CLI tool. + +1. Save your web3 account private key. -

4.1. In the Metamask window, click your current account name:

+

1.1. In the Metamask window, click your current account name:



-

4.2. Open **Account details**:

+

1.2. Open **Account details**:



-

4.3. Press the **Show private key** button in the **Details** tab:

+

1.3. Press the **Show private key** button in the **Details** tab:



-

4.4. Copy and save your web3 account private key. You will need it to set up SPCTL—the Super Protocol CLI tool.

+

1.4. Copy and save your web3 account private key.

+ +2. Set up a Storj account. + +

2.1. Register a [Storj](https://www.storj.io/) account if you do not have one yet.

-5. Download SPCTL. +

2.2. Create a bucket. Refer to the [Storj documentation](https://docs.storj.io/dcs/getting-started/quickstart-objectbrowser/) for guidance.

+ +

2.3. Create two access grants for this bucket. One should provide **Full** permission (**Read**, **List**, **Write**, **Delete**), and the other one **Read** permission. Refer to the [Storj guide](https://docs.storj.io/dcs/getting-started/quickstart-uplink-cli/uploading-your-first-object/create-first-access-grant/) to generate access grants.

+ +3. Download SPCTL. @@ -79,25 +91,23 @@ import TabItem from '@theme/TabItem'; You can also download and install SPCTL manually from the Super Protocol [GitHub repository](https://github.com/Super-Protocol/ctl). -6. Configure SPCTL. +4. Configure SPCTL. -

6.1. Start a setup dialog:

+

4.1. Start a setup dialog:

```shell ./spctl setup ``` -

6.2. Enter the following Access Token when prompted:

+

4.2. Enter the following Access Token when prompted:

``` eyJhbGciOiJFUzI1NiJ9.eyJhZGRyZXNzIjoiMHhBN0E5NjQ4ZGE2QTg5QjBhNzFhNGMwRDQ2Y2FENDAwMDU3ODI3NGEyIiwiaWF0IjoxNjc5OTk4OTQyLCJleHAiOjE3NDMxMTQxNDJ9.x2lx90D733mToYYdOWhh4hhXn3YowFW4JxFjDFtI7helgp2uqekDHFgekT5yjbBWeHTzRap7SHbDC3VvMIDe0g ``` -

6.3. Enter your web3 account private key when prompted.

- - -

6.4. Answer `No` when promted about a Storj bucket. You can [configure Storj](/cli/#set-up-storj-access-optional) later or skip this step entirely.

+

4.3. Enter your web3 account private key.

+

4.4. Answer `y` when asked about a Storj bucket. When prompted, enter the name of the Storj bucket and the bucket access grants with **Read** and **Full** permissions.

When done, SPCTL creates `config.json` in its directory. If you need to update your account information, run `./spctl setup` again or modify `config.json` manually in a text editor. @@ -160,7 +170,7 @@ tar -czvf .tar.gz -C . Replace: -- `` with a desired name of your data +- `` with a desired name - `` with the path to the data directory Do not omit the dot `.` at the end of the command.