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

Jump to bottom

docs: Improve clarity on --cache. #9489

Merged
merged 1 commit into from
Nov 21, 2024
+9 −5
Merged

docs: Improve clarity on --cache. #9489

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 9 additions & 5 deletions docs/repo-docs/reference/run.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,23 +67,27 @@ Specify caching sources for the run. Accepts a comma-separated list of options:
- `local`: Use the local filesystem cache
- `remote`: Use the Remote Cache
When an option is omitted, reading and writing are both disabled
When an a caching source is omitted, reading and writing are both disabled.
Each option must be followed by one of:
Cache sources use the following values:
- `rw`: Read and write
- `r`: Read only
- `w`: Write only
- None (`local:`) : Does not use cache. Equivalent to omitting the cache source option.
```bash title="Terminal"
# Read and write to local cache, read only to Remote Cache
# Read from and write to local cache. Only read from Remote Cache.
turbo run build --cache=local:rw,remote:r
# Read-only to local cache, read write to Remote Cache
# Only read from local cache. Read from and write to Remote Cache.
turbo run build --cache=local:r,remote:rw
# Read and write to local cache, no Remote Cache activity
# Read from and write to local cache. No Remote Cache activity.
turbo run build --cache=local:rw
# Do not use local cache. Only read from Remote Cache.
turbo run build --cache=local:,remote:r
```
### `--cache-dir <path>`
Expand Down
Loading