Skip to content
Console
On this page

sylphx build build_caches

Every sylphx build build_caches command: its argument, its flags and a run line.

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

Shell
sylphx build build-caches get orgs/acme/projects/shop/build_caches/build-cache

GET 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

Shell
sylphx build build-caches list orgs/acme/projects/shop

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches · scope build:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter over labels, filterable fields, and Ready.
--order-bystringAIP-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

Shell
sylphx build build-caches update orgs/acme/projects/shop/build_caches/build-cache

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache · scope build:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--spec.retentiondurationEntries unused this long are evicted; default 7 days.
--allow-missingboolCreate the Resource when it does not exist (declarative upsert).
--dry-runboolValidate 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

Shell
sylphx build build-caches delete orgs/acme/projects/shop/build_caches/build-cache --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache · scope build:write · effect destructive · Request, response and examples

Flags

FlagTypeWhat it does
--etagstringDelete only if the current etag matches.
--allow-missingboolSucceed when the Resource does not exist.
--dry-runboolValidate and print the result without writing (validate_only).
--yesboolDo 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

Shell
sylphx build build-caches mint-env orgs/acme/projects/shop/build_caches/build-cache

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache:mintEnv · scope build:run · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--accessenumWhat 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

Shell
sylphx build build-caches purge orgs/acme/projects/shop/build_caches/build-cache --yes

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache:purge · scope build:write · effect destructive · Request, response and examples

Flags

FlagTypeWhat it does
--etagstringPurge only if the current etag matches.
--dry-runboolValidate and print the result without writing (validate_only).
--no-waitboolReturn the call at once instead of waiting for it to finish.
--yesboolDo not ask before this destructive call.