Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify login url usage #9963

Merged
merged 2 commits into from
Feb 14, 2025
Merged

docs: clarify login url usage #9963

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
533036c
docs: clarify login url usage
anthonyshew Feb 14, 2025
6af40d5
Apply suggestions from code review
anthonyshew Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/repo-docs/reference/link.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,22 @@ The selected owner (either a user or an organization) will be able to share [cac

Specifies the URL of your Remote Cache provider.

```bash title="Terminal"
turbo link --api=https://example.com
```

### `--yes`

Answer yes to all prompts

```bash title="Terminal"
turbo link --yes
```

### `--scope <scope>`

The scope, i.e. Vercel team, to which you are linking
The scope to which you are linking. For example, when using Vercel, this is your Vercel team's slug.

```bash title="Terminal"
turbo link --api https://acme.com
turbo link --scope=your-team
```
2 changes: 1 addition & 1 deletion docs/repo-docs/reference/login.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ turbo login --api=https://acme.com/api

### --login \<url>

Set the URL for login requests. This is only required for platforms with robust login features.
Set the URL for login requests that should dynamically generate tokens.

```bash title="Terminal"
turbo login --login=https://acme.com
Expand Down
3 changes: 2 additions & 1 deletion docs/repo-docs/reference/system-environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,8 @@ System environment variables are always overridden by flag values provided direc
</td>
<td>
Set the URL used to log in to{' '}
<a href="/repo/docs/core-concepts/remote-caching">Remote Cache</a>.
<a href="/repo/docs/core-concepts/remote-caching">Remote Cache</a>. Only
needed for self-hosted Remote Caches that implement an endpoint that dynamically creates tokens.
</td>
</tr>
<tr id="turbo_no_update_notifier">
Expand Down
Loading