Skip to content

Commit

Permalink
Document --cache flag. (#9427)
Browse files Browse the repository at this point in the history
# DO NOT MERGE CONDITION
2.3 release.

### Description

Documenting #9348 

### Testing Instructions

👀

---------

Co-authored-by: Nicholas Yang <nicholas.yang@vercel.com>
  • Loading branch information
anthonyshew and NicholasLYang authored Nov 14, 2024
1 parent 43ab1c7 commit 649a096
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/repo-docs/reference/run.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,34 @@ TURBO_SCM_HEAD=your-branch turbo run build --affected
changed.
</Callout>
### `--cache <options>`
Default: `local:rw,remote:rw`
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
Each option must be followed by one of:
- `rw`: Read and write
- `r`: Read only
- `w`: Write only
```bash title="Terminal"
# Read and write to local cache, read only to Remote Cache
turbo run build --cache=local:rw,remote:r
# Read-only to local cache, read write to Remote Cache
turbo run build --cache=local:r,remote:rw
# Read and write to local cache, no Remote Cache activity
turbo run build --cache=local:rw
```
### `--cache-dir <path>`
Default: `.turbo/cache`
Expand Down

0 comments on commit 649a096

Please sign in to comment.