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
+40-25Lines changed: 40 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,25 +17,55 @@ Recce Cloud allows you to share your Recce validation results with full context,
17
17
18
18
When you're ready to share your lineage exploration, query results, or validation checklist, simply click **Share** in Recce.
19
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
-
20
+
The first time you do this, you'll need to associate your local Recce to Recce Cloud. This requires signing in and setting the association of local Recce. Once associated, Recce Cloud will host your state file securely, allowing you to share a link that others can open in their browsers.
21
+
`
22
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 **Use Recce Cloud** button if you are not associating Recce with Recce Cloud before.
### 2. Sign in to Recce Cloud and grand access permission
29
+
30
+
Once your login is successful, your local Recce will be prompted to grant access to Recce Cloud. This step is crucial for enabling the sharing functionality.
### 2. Sign in to Recce Cloud and retrieve your API token
34
+
### 3. Refresh the page
35
+
After granting access, you need to refresh the Recce page. This will ensure that your local Recce is now associated with Recce Cloud and ready for sharing. You'll see the **Share** button, then you can click it to get the link on top.
36
+
37
+
{: .shadow}
38
+
39
+
!!! info
40
+
**Note:** If you haven't wanted to start the Recce Server, you can also use the `recce connect-to-cloud` command to associate your local Recce to Recce Cloud. This command will prompt you to sign in and grant access permission.
41
+
42
+
```bash
43
+
recce connect-to-cloud
44
+
```
45
+
46
+
47
+
## Configure recce cloud association manually
48
+
If you prefer to set up the Recce Cloud association manually or your are running Recce under the container environment, you can do so by following these steps:
49
+
50
+
### 1. Sign in to Recce Cloud and retrieve your API token
29
51
30
52
Copy your API token from the [personal settings page](https://cloud.datarecce.io/settings#tokens) in Recce Cloud.
31
53
32
54
{: .shadow}
33
55
34
-
### 3. Add the token to `.recce/profile.yml`
35
56
36
-
For convenience, you can add your API token in `.recce/profile.yml`, located in your home directory.
57
+
### 2. Configure your local Recce to use Recce Cloud
58
+
You can launch Recce server with the `--api-token` flag to associate with Recce Cloud. Once the token is set, your api token will be saved in your `~/.recce/profile.yml` file, and you won't need to set it again.
59
+
60
+
```bash
61
+
recce server --api-token <your_api_token>
62
+
```
37
63
38
-
- Find the `.recce` folder in your home directory.
64
+
Or you can modify your `~/.recce/profile.yml` file by text editor to include your Recce Cloud API token:
65
+
66
+
```yaml
67
+
api_token: <your_api_token>
68
+
```
39
69
40
70
!!! info
41
71
**For Mac/Linux users:** In the terminal, type the following command to navigate to the Recce configuration directory:
@@ -49,27 +79,12 @@ For convenience, you can add your API token in `.recce/profile.yml`, located in
49
79
cd ~\.recce
50
80
```
51
81
52
-
- Open `profile.yml` with any text editor to add your token:
53
-
```yaml
54
-
api_token: <your_api_token>
55
-
```
56
-
57
-
!!! note
58
-
Alternatively, for one-time use, you can use `--api-token` flag with the following command:
59
-
```bash
60
-
recce server --api-token <your_api_token>
61
-
```
62
82
63
-
### 4. Relaunch Recce server
64
-
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.
67
-
68
-
{: .shadow}
83
+
## Share Recce state file from CLI
69
84
70
85
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
86
```bash
72
87
recce share <your_state_file>
73
-
recce share --api-token <your_api_token> <your_state_file> # for one-time use
88
+
recce share --api-token <your_api_token> <your_state_file> # if you are not associating Recce with Recce Cloud before
74
89
```
75
90
{: .shadow}
0 commit comments