Buildkite CLI cache command
The bk cache command allows you to manage Buildkite cache resources from the command line.
| Command |
Description |
bk cache registry list |
List cluster cache registries. |
bk cache registry view |
View a cluster cache registry. |
bk cache registry create |
Create a new cluster cache registry. |
bk cache registry update |
Update a cluster cache registry. |
bk cache registry delete |
Delete a cluster cache registry. |
List cluster cache registries.
bk cache registry list <cluster-uuid> [flags]
| Argument |
Description |
<cluster-uuid> |
Cluster UUID to list cache registries for |
| Flag |
Description |
-o, --output=""
|
Output format. One of: json, yaml, text |
--debug |
Enable debug output for REST API calls |
--json |
Output as JSON |
--limit=100 |
Maximum number of cache registries to return |
--per-page=30 |
Number of cache registries per page |
--text |
Output as text |
--yaml |
Output as YAML |
bk cache registry list my-cluster-uuid
bk cache registry list my-cluster-uuid --limit 200
bk cache registry list my-cluster-uuid --output json
View a cluster cache registry.
bk cache registry view <cluster-uuid> <registry-uuid> [flags]
| Argument |
Description |
<cluster-uuid> |
Cluster UUID the cache registry belongs to |
<registry-uuid> |
Cache registry UUID to view |
| Flag |
Description |
-o, --output=""
|
Output format. One of: json, yaml, text |
--debug |
Enable debug output for REST API calls |
--json |
Output as JSON |
--text |
Output as text |
--yaml |
Output as YAML |
Create a new cluster cache registry.
bk cache registry create --name=STRING <cluster-uuid> [flags]
| Argument |
Description |
<cluster-uuid> |
Cluster UUID to create the cache registry in |
| Flag |
Description |
-o, --output=""
|
Output format. One of: json, yaml, text |
--color=COLOR |
Color for the cache registry |
--debug |
Enable debug output for REST API calls |
--description=DESCRIPTION |
Description for the cache registry |
--emoji=EMOJI |
Emoji for the cache registry |
--json |
Output as JSON |
--name=STRING |
Name for the cache registry |
--policy-file=STRING |
Read the policy from a YAML or JSON file, or from stdin with -
|
--text |
Output as text |
--yaml |
Output as YAML |
Create with the default unrestricted policy (trusted builds only):
bk cache registry create my-cluster-uuid --name "Ruby gems"
Create with an explicit policy:
bk cache registry create my-cluster-uuid --name "Ruby gems" --policy-file policy.yml
cat policy.json | bk cache registry create my-cluster-uuid --name "Ruby gems" --policy-file -
Update a cluster cache registry.
bk cache registry update <cluster-uuid> <registry-uuid> [flags]
| Argument |
Description |
<cluster-uuid> |
Cluster UUID the cache registry belongs to |
<registry-uuid> |
Cache registry UUID to update |
| Flag |
Description |
-o, --output=""
|
Output format. One of: json, yaml, text |
--clear-color |
Clear the cache registry color |
--clear-description |
Clear the cache registry description |
--clear-emoji |
Clear the cache registry emoji |
--clear-policy |
Clear the policy, denying all cache saves and restores |
--color=COLOR |
New color for the cache registry |
--debug |
Enable debug output for REST API calls |
--description=DESCRIPTION |
New description for the cache registry |
--emoji=EMOJI |
New emoji for the cache registry |
--json |
Output as JSON |
--name=NAME |
New name for the cache registry (regenerates its slug) |
--policy-file=STRING |
Read the new policy from a YAML or JSON file, or from stdin with -
|
--text |
Output as text |
--yaml |
Output as YAML |
bk cache registry update my-cluster-uuid my-registry-uuid --name "Ruby gems"
bk cache registry update my-cluster-uuid my-registry-uuid --policy-file policy.yml
bk cache registry update my-cluster-uuid my-registry-uuid --clear-description
Delete a cluster cache registry.
bk cache registry delete <cluster-uuid> <registry-uuid>
| Argument |
Description |
<cluster-uuid> |
Cluster UUID the cache registry belongs to |
<registry-uuid> |
Cache registry UUID to delete |
| Flag |
Description |
--debug |
Enable debug output for REST API calls |
bk cache registry delete my-cluster-uuid my-registry-uuid
bk cache registry delete my-cluster-uuid my-registry-uuid --yes
