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
{{ message }}
This repository was archived by the owner on May 9, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/docs/recce-cloud/share-recce-session-securely.md
+21-8
Original file line number
Diff line number
Diff line change
@@ -11,30 +11,43 @@ Recce Cloud allows you to share your Recce validation results with full context,
11
11
12
12
!!! Note
13
13
14
-
Please note that Recce users with the link can visit your sharing session. If you need to restrict access, please contact us.
14
+
Please note that anyone with the link can visit your shared Recce after sign in Recce Cloud. If you need to restrict access, [please contact us](https://cal.com/team/recce/chat).
15
15
16
16
## How to use
17
17
18
-
1. Obtain API token from Recce Cloud
19
-
20
-
To connect to your Recce Cloud account, you need an API token. Please copy your API Token from the [personal settings page](https://cloud.datarecce.io/settings#tokens) in Recce Cloud.
18
+
When you're ready to share your lineage exploration, query results, or validation checklist, simply click **Share** in Recce.
19
+
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
+
22
+
1. Enable Recce Sharing
23
+
24
+
To start sharing, launch Recce server and click the **Enable Sharing** button.
Copy your API token from the [personal settings page](https://cloud.datarecce.io/settings#tokens) in Recce Cloud.
31
+
21
32
{: .shadow}
22
33
23
34
1. Add the token to `.recce/profile.yml`
24
35
25
-
For convenience, you can enter your API token in `.recce/profile.yml`, located by default in your home directory.
36
+
For convenience, you can add your API token in `.recce/profile.yml`, located by default in your home directory.
26
37
```yaml
27
38
user_id: <your_user_id>
28
39
api_token: <your_api_token>
29
40
```
30
-
Or, you can use `--api-token` flag with commend for one-time use. e.g.,
41
+
Alternatively, for one-time use, you can use `--api-token` flag with commend. e.g.,
31
42
```bash
32
43
recce server --api-token <your_api_token>
33
44
```
34
45
35
-
1. Start Recce server
46
+
1. Relaunch Recce server
47
+
48
+
After adding the API token, restarting Recce server is required to load the new configuration.
49
+
Once it's running, you'll see the **Share** button, then you can click it to get the link on top.
36
50
37
-
After launching, you'll see the __Share__ button at the top, then you can click it to get the link.
38
51
{: .shadow}
39
52
40
53
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.
0 commit comments