|
| 1 | +--- |
| 2 | +title: Share Recce Session |
| 3 | +icon: material/account-eye |
| 4 | +--- |
| 5 | + |
| 6 | +## Share your validation results with anyone, no setup needed |
| 7 | + |
| 8 | +If you've already used Recce to validate your PR and prepared checks, but stakeholders might not have the environment to run Recce. |
| 9 | + |
| 10 | +Recce Cloud allows you to share your Recce validation results with full context, using a simple link. Stakeholders can open a read-only Recce view directly in their browser. No installation, no configuration, just instant access. |
| 11 | + |
| 12 | +!!! Note |
| 13 | + |
| 14 | + Please note that Recce users with the link can visit your sharing session. If you need to restrict access, please contact us. |
| 15 | + |
| 16 | +## How to use |
| 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. |
| 21 | + {: .shadow} |
| 22 | + |
| 23 | +1. Add the token to `.recce/profile.yml` |
| 24 | + |
| 25 | + For convenience, you can enter your API token in `.recce/profile.yml`, located by default in your home directory. |
| 26 | + ```yaml |
| 27 | + user_id: <your_user_id> |
| 28 | + api_token: <your_api_token> |
| 29 | + ``` |
| 30 | + Or, you can use `--api-token` flag with commend for one-time use. e.g., |
| 31 | + ```bash |
| 32 | + recce server --api-token <your_api_token> |
| 33 | + ``` |
| 34 | + |
| 35 | +1. Start Recce server |
| 36 | + |
| 37 | + After launching, you'll see the __Share__ button at the top, then you can click it to get the link. |
| 38 | + {: .shadow} |
| 39 | + |
| 40 | + 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. |
| 41 | + ```bash |
| 42 | + recce share <your_state_file> |
| 43 | + recce share --api-token <your_api_token> <your_state_file> # for one-time use |
| 44 | + ``` |
| 45 | + {: .shadow} |
0 commit comments