Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx build build_caches
Every sylphx build build_caches command: its argument, its flags and a run line.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
The build_caches commands of Sylphx Build, as the CLI spells them: the same
calls as the build_caches API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a build cache.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx build build-caches get orgs/acme/projects/shop/build_caches/build-cacheGET https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache · scope build:read · effect read · Request, response and examples
#list
Lists build caches in a project.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx build build-caches list orgs/acme/projects/shopGET https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches · scope build:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | AIP-160 filter over labels, filterable fields, and Ready. |
--order-by | string | AIP-132 ordering over filterable fields. |
#update
Updates a build cache.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx build build-caches update orgs/acme/projects/shop/build_caches/build-cachePATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache · scope build:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.retention | duration | Entries unused this long are evicted; default 7 days. |
--allow-missing | bool | Create the Resource when it does not exist (declarative upsert). |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes a build cache.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx build build-caches delete orgs/acme/projects/shop/build_caches/build-cache --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache · scope build:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--allow-missing | bool | Succeed when the Resource does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--yes | bool | Do not ask before this destructive call. |
#mint-env
Mints the settings a build that runs elsewhere (a laptop, a CI runner) uses to reach the cache: the sccache, Turbo and crates mirror doors and a short-lived token, as environment variables.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx build build-caches mint-env orgs/acme/projects/shop/build_caches/build-cachePOST https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache:mintEnv · scope build:run · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--access | enum | What the token may do; default READ. One of read, read_write. |
#purge
Empties a build cache and keeps the cache. The undo is that the next build refills it.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx build build-caches purge orgs/acme/projects/shop/build_caches/build-cache --yesPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache:purge · scope build:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Purge only if the current etag matches. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--no-wait | bool | Return the call at once instead of waiting for it to finish. |
--yes | bool | Do not ask before this destructive call. |