You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/recce-cloud/share-recce-session-securely.md
+35-37Lines changed: 35 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,59 +19,57 @@ When you're ready to share your lineage exploration, query results, or validatio
19
19
20
20
The first time you do this, you'll need to connect your local Recce to Recce Cloud. This requires signing in and setting up an API token. Once connected, Recce Cloud will host your state file securely, allowing you to share a link that others can open in their browsers.
21
21
22
-
1. Enable Recce Sharing
22
+
### 1. Enable Recce Sharing
23
23
24
-
To start sharing, launch Recce server and click the **Enable Sharing** button.
24
+
To start sharing, launch Recce server and click the **Enable Sharing** button.
### 2. Sign in to Recce Cloud and retrieve your API token
29
29
30
-
Copy your API token from the [personal settings page](https://cloud.datarecce.io/settings#tokens) in Recce Cloud.
30
+
Copy your API token from the [personal settings page](https://cloud.datarecce.io/settings#tokens) in Recce Cloud.
31
31
32
-
{: .shadow}
32
+
{: .shadow}
33
33
34
-
1. Add the token to `.recce/profile.yml`
34
+
### 3. Add the token to `.recce/profile.yml`
35
35
36
-
For convenience, you can add your API token in `.recce/profile.yml`, located in your home directory.
36
+
For convenience, you can add your API token in `.recce/profile.yml`, located in your home directory.
37
37
38
-
- Find the `.recce` folder in your home directory.
38
+
- Find the `.recce` folder in your home directory.
39
39
40
-
**For Mac/Linux users:**
41
-
42
-
In the terminal, type the following command to navigate to the Recce configuration directory:
43
-
```shell
44
-
cd~/.recce
45
-
```
46
-
47
-
**For Windows users:**
40
+
!!! info
41
+
**For Mac/Linux users:** In the terminal, type the following command to navigate to the Recce configuration directory:
42
+
```shell
43
+
cd ~/.recce
44
+
```
45
+
**For Windows users:** Navigate to `C:\Users\<your_user_name>` and open the hidden `.recce` folder.
48
46
49
-
Navigate to `C:\Users\<your_user_name>` and open the hidden `.recce` folder.
47
+
Or in PowerShell, type:
48
+
```powershell
49
+
cd ~\.recce
50
+
```
50
51
51
-
Or in PowerShell, type:
52
-
```powershell
53
-
cd~\.recce
54
-
```
52
+
- Open `profile.yml` with any text editor to add your token:
53
+
```yaml
54
+
api_token: <your_api_token>
55
+
```
55
56
56
-
- Open `profile.yml` with any text editor to add your token:
57
-
```yaml
58
-
api_token: <your_api_token>
59
-
```
60
-
Alternatively, for one-time use, you can use `--api-token` flag with commend. e.g.,
57
+
!!! note
58
+
Alternatively, for one-time use, you can use `--api-token` flag with the following command:
61
59
```bash
62
60
recce server --api-token <your_api_token>
63
61
```
64
62
65
-
1. Relaunch Recce server
63
+
### 4. Relaunch Recce server
66
64
67
-
After adding the API token, restarting Recce server is required to load the new configuration.
68
-
Once it's running, you'll see the **Share** button, then you can click it to get the link on top.
65
+
After adding the API token, restarting Recce server is required to load the new configuration.
66
+
Once it's running, you'll see the **Share** button, then you can click it to get the link on top.
69
67
70
-
{: .shadow}
68
+
{: .shadow}
71
69
72
-
You can also use the `recce share` command. If you already have a prepared Recce state file, you can obtain a share link directly through the command line.
73
-
```bash
74
-
recce share <your_state_file>
75
-
recce share --api-token <your_api_token><your_state_file># for one-time use
76
-
```
77
-
{: .shadow}
70
+
You can also use the `recce share` command. If you already have a prepared Recce state file, you can obtain a share link directly through the command line.
71
+
```bash
72
+
recce share <your_state_file>
73
+
recce share --api-token <your_api_token> <your_state_file> # for one-time use
74
+
```
75
+
{: .shadow}
0 commit comments