@zuke/gcloud

`@zuke/gcloud` — typed Google Cloud tooling for Zuke builds: the `gcloud`

Symbols

AccessTokenProvider

type

type AccessTokenProvider = unknown

Supplies a Google Cloud OAuth access token for a REST call.

gcloudAccessToken

function

function gcloudAccessToken(run?: GcloudRunner): Promise<string>

The default AccessTokenProvider: the trimmed stdout of gcloud auth print-access-token, run with --quiet so the token never streams to the build log. run defaults to "./gcloud.ts".GcloudTasks .run and is injectable for tests.

GcloudArtifactsImagesDeleteSettings

class

class GcloudArtifactsImagesDeleteSettings extends GcloudSettings

Settings for gcloud artifacts docker images delete.

Member	Signature	Doc
`image`	`image(reference: string): this`	The image or version to delete (positional).
`deleteTags`	`deleteTags(): this`	Delete the version even though tags point at it (`--delete-tags`), which gcloud otherwise refuses.

GcloudArtifactsImagesListSettings

class

class GcloudArtifactsImagesListSettings extends GcloudSettings

Settings for gcloud artifacts docker images list.

Member	Signature	Doc
`repository`	`repository(path: string): this`	The repository or image to list (positional).
`includeTags`	`includeTags(): this`	Include each version's tags (`--include-tags`).
`limit`	`limit(value: number): this`	Return at most this many images (`--limit`).
`filter`	`filter(expression: string): this`	Restrict the listing (`--filter`).

GcloudArtifactsRepositoriesDescribeSettings

class

class GcloudArtifactsRepositoriesDescribeSettings extends GcloudSettings

Settings for gcloud artifacts repositories describe.

Member	Signature	Doc
`repository`	`repository(name: string): this`	The repository to describe (positional).
`location`	`location(value: string): this`	The location it lives in (`--location`).

GcloudArtifactsRepositoriesListSettings

class

class GcloudArtifactsRepositoriesListSettings extends GcloudSettings

Settings for gcloud artifacts repositories list.

Member	Signature	Doc
`location`	`location(value: string): this`	The location to list from (`--location`).
`limit`	`limit(value: number): this`	Return at most this many repositories (`--limit`).

GcloudAuthActivateServiceAccountSettings

class

class GcloudAuthActivateServiceAccountSettings extends GcloudSettings

Settings for gcloud auth activate-service-account.

Member	Signature	Doc
`serviceAccount`	`serviceAccount(email: string): this`	The service account to activate (positional); optional beside a key file.
`keyFile`	`keyFile(path: string): this`	The JSON key to activate it from (`--key-file`).

GcloudAuthConfigureDockerSettings

class

class GcloudAuthConfigureDockerSettings extends GcloudSettings

Settings for gcloud auth configure-docker.

Member	Signature	Doc
`registries`	`registries(...values: string[]): this`	The registries to add a credential helper for (positional, comma separated), e.g. `"us-central1-docker.pkg.dev"`; repeatable.

GcloudAuthListSettings

class

class GcloudAuthListSettings extends GcloudSettings

Settings for gcloud auth list.

Member	Signature	Doc
`filterAccount`	`filterAccount(email: string): this`	Only the named account (`--filter-account`).

GcloudAuthPrintAccessTokenSettings

class

class GcloudAuthPrintAccessTokenSettings extends GcloudSettings

Settings for gcloud auth print-access-token.

Member	Signature	Doc
`forAccount`	`forAccount(email: string): this`	Print the token for this account rather than the active one (positional).

GcloudAuthPrintIdentityTokenSettings

class

class GcloudAuthPrintIdentityTokenSettings extends GcloudSettings

Settings for gcloud auth print-identity-token.

Member	Signature	Doc
`forAccount`	`forAccount(email: string): this`	Print the token for this account rather than the active one (positional).
`audiences`	`audiences(...values: string[]): this`	The audiences the token is minted for (`--audiences`); repeatable. A Cloud Run service invoked service-to-service is the usual reason: the receiving service's URL is the audience, and a token minted without one is rejected there.
`includeEmail`	`includeEmail(): this`	Include the service account email in the token (`--include-email`).

GcloudAuthRevokeSettings

class

class GcloudAuthRevokeSettings extends GcloudSettings

Settings for gcloud auth revoke.

Member	Signature	Doc
`accounts`	`accounts(...values: string[]): this`	The accounts to revoke (positional); repeatable.
`all`	`all(): this`	Revoke every credentialed account (`--all`).

GcloudBuildsDescribeSettings

class

class GcloudBuildsDescribeSettings extends GcloudSettings

Settings for gcloud builds describe.

Member	Signature	Doc
`build`	`build(id: string): this`	The build to describe (positional).
`region`	`region(value: string): this`	The region it ran in (`--region`).

GcloudBuildsListSettings

class

class GcloudBuildsListSettings extends GcloudSettings

Settings for gcloud builds list.

Member	Signature	Doc
`limit`	`limit(value: number): this`	Return at most this many builds (`--limit`).
`filter`	`filter(expression: string): this`	Restrict the listing (`--filter`), e.g. `"status=SUCCESS"`.
`region`	`region(value: string): this`	The region to list from (`--region`).
`ongoing`	`ongoing(): this`	Only builds that have not finished (`--ongoing`).

GcloudBuildsLogSettings

class

class GcloudBuildsLogSettings extends GcloudSettings

Settings for gcloud builds log.

Member	Signature	Doc
`build`	`build(id: string): this`	The build whose log to read (positional).
`stream`	`stream(): this`	Follow the log until the build finishes (`--stream`), which makes the task block for the build's duration rather than returning what exists now.
`region`	`region(value: string): this`	The region it ran in (`--region`).

GcloudBuildsSubmitSettings

class

class GcloudBuildsSubmitSettings extends GcloudSettings

Settings for gcloud builds submit.

Member	Signature	Doc
`source`	`source(path: string): this`	The source to build (positional), e.g. `"."` or a `gs://` archive.
`tag`	`tag(image: string): this`	Build a container and push it to this tag (`--tag`).
`config`	`config(path: string): this`	Build from a config file (`--config`), e.g. `cloudbuild.yaml`.
`pack`	`pack(spec: string): this`	Build with buildpacks (`--pack`), e.g. `"image=gcr.io/p/i"`.
`timeout`	`timeout(value: string): this`	Fail the build after this long (`--timeout`), e.g. `"600s"`.
`machineType`	`machineType(value: string): this`	The machine type to build on (`--machine-type`).
`substitutions`	`substitutions(...pairs: string[]): this`	Substitution values for the config (`--substitutions`); repeatable.
`async`	`async(): this`	Return as soon as the build is queued (`--async`).
`gcsSourceStagingDir`	`gcsSourceStagingDir(uri: string): this`	Stage the source under this bucket path (`--gcs-source-staging-dir`).
`ignoreFile`	`ignoreFile(path: string): this`	Exclude files matching this ignore file (`--ignore-file`).
`region`	`region(value: string): this`	The region to build in (`--region`).

GcloudClustersDescribeSettings

class

class GcloudClustersDescribeSettings extends GcloudSettings

Settings for gcloud container clusters describe.

Member	Signature	Doc
`cluster`	`cluster(name: string): this`	The cluster to describe (positional).
`location`	`location(value: string): this`	The cluster's location (`--location`).
`region`	`region(value: string): this`	The cluster's region (`--region`).
`zone`	`zone(value: string): this`	The cluster's zone (`--zone`).

GcloudClustersGetCredentialsSettings

class

class GcloudClustersGetCredentialsSettings extends GcloudSettings

Settings for gcloud container clusters get-credentials.

Member	Signature	Doc
`cluster`	`cluster(name: string): this`	The cluster to fetch credentials for (positional).
`location`	`location(value: string): this`	The cluster's location (`--location`).
`region`	`region(value: string): this`	The cluster's region (`--region`).
`zone`	`zone(value: string): this`	The cluster's zone (`--zone`).
`internalIp`	`internalIp(): this`	Use the internal endpoint (`--internal-ip`), for a private cluster.
`dnsEndpoint`	`dnsEndpoint(): this`	Use the DNS endpoint (`--dns-endpoint`).

GcloudClustersListSettings

class

class GcloudClustersListSettings extends GcloudSettings

Settings for gcloud container clusters list.

Member	Signature	Doc
`location`	`location(value: string): this`	Restrict to a location (`--location`).
`region`	`region(value: string): this`	Restrict to a region (`--region`).
`zone`	`zone(value: string): this`	Restrict to a zone (`--zone`).
`filter`	`filter(expression: string): this`	Restrict the listing (`--filter`).

GcloudConfigGetValueSettings

class

class GcloudConfigGetValueSettings extends GcloudSettings

Settings for gcloud config get-value.

Member	Signature	Doc
`property`	`property(name: string): this`	The property to read (positional).

GcloudConfigListSettings

class

class GcloudConfigListSettings extends GcloudSettings

Settings for gcloud config list.

Member	Signature	Doc
`all`	`all(): this`	Include properties left at their defaults (`--all`).

GcloudConfigSetSettings

class

class GcloudConfigSetSettings extends GcloudSettings

Settings for gcloud config set.

Member	Signature	Doc
`property`	`property(name: string): this`	The property to set (positional), e.g. `"project"` or `"run/region"`.
`value`	`value(text: string): this`	The value to set it to (positional).

GcloudConfigUnsetSettings

class

class GcloudConfigUnsetSettings extends GcloudSettings

Settings for gcloud config unset.

Member	Signature	Doc
`property`	`property(name: string): this`	The property to clear (positional).

GcloudFunctionsDeploySettings

class

class GcloudFunctionsDeploySettings extends GcloudSettings

Settings for gcloud functions deploy.

Member	Signature	Doc
`function`	`function(name: string): this`	The function to deploy (positional).
`runtime`	`runtime(value: string): this`	The language runtime (`--runtime`), e.g. `"nodejs20"`.
`region`	`region(value: string): this`	The region to deploy into (`--region`).
`entryPoint`	`entryPoint(value: string): this`	The exported symbol to invoke (`--entry-point`).
`source`	`source(path: string): this`	Where the source lives (`--source`).
`triggerHttp`	`triggerHttp(): this`	Trigger on HTTP requests (`--trigger-http`).
`triggerTopic`	`triggerTopic(name: string): this`	Trigger on a Pub/Sub topic (`--trigger-topic`).
`triggerBucket`	`triggerBucket(name: string): this`	Trigger on a Cloud Storage bucket (`--trigger-bucket`).
`triggerEventFilters`	`triggerEventFilters(...filters: string[]): this`	Trigger on matching Eventarc events (`--trigger-event-filters`).
`serviceAccount`	`serviceAccount(email: string): this`	The identity the function runs as (`--service-account`).
`setEnvVars`	`setEnvVars(...pairs: string[]): this`	Environment variables (`--set-env-vars`), as `KEY=value`; repeatable.
`memory`	`memory(value: string): this`	Memory per instance (`--memory`).
`timeout`	`timeout(value: string): this`	Execution timeout (`--timeout`).
`gen2`	`gen2(): this`	Deploy as a 2nd-generation function (`--gen2`).

GcloudFunctionsDescribeSettings

class

class GcloudFunctionsDescribeSettings extends GcloudSettings

Settings for gcloud functions describe.

Member	Signature	Doc
`function`	`function(name: string): this`	The function to describe (positional).
`region`	`region(value: string): this`	The region it runs in (`--region`).
`gen2`	`gen2(): this`	Look it up as a 2nd-generation function (`--gen2`).

GcloudRunDeploySettings

class

class GcloudRunDeploySettings extends GcloudSettings

Settings for gcloud run deploy.

Member	Signature	Doc
`service`	`service(name: string): this`	The service to deploy (positional).
`image`	`image(reference: string): this`	The container image to deploy (`--image`).
`source`	`source(path: string): this`	Build and deploy from source instead of an image (`--source`).
`region`	`region(value: string): this`	The region to deploy into (`--region`).
`platform`	`platform(value: string): this`	The platform to target (`--platform`), e.g. `"managed"`.
`allowUnauthenticated`	`allowUnauthenticated(): this`	Let unauthenticated callers invoke the service (`--allow-unauthenticated`).
`noAllowUnauthenticated`	`noAllowUnauthenticated(): this`	Require authentication to invoke it (`--no-allow-unauthenticated`).
`serviceAccount`	`serviceAccount(email: string): this`	The identity the service runs as (`--service-account`).
`setEnvVars`	`setEnvVars(...pairs: string[]): this`	Environment variables (`--set-env-vars`), as `KEY=value`; repeatable.
`setSecrets`	`setSecrets(...pairs: string[]): this`	Secret Manager mounts (`--set-secrets`); repeatable.
`memory`	`memory(value: string): this`	Memory per instance (`--memory`), e.g. `"512Mi"`.
`cpu`	`cpu(value: string): this`	CPU per instance (`--cpu`).
`concurrency`	`concurrency(value: number): this`	Requests served concurrently per instance (`--concurrency`).
`maxInstances`	`maxInstances(value: number): this`	Upper bound on instances (`--max-instances`).
`minInstances`	`minInstances(value: number): this`	Lower bound on instances (`--min-instances`).
`port`	`port(value: number): this`	The port the container listens on (`--port`).
`timeout`	`timeout(value: string): this`	Request timeout (`--timeout`).
`tag`	`tag(value: string): this`	Tag this revision (`--tag`), so it is addressable without traffic.
`noTraffic`	`noTraffic(): this`	Deploy without moving traffic to the new revision (`--no-traffic`).

GcloudRunner

type

type GcloudRunner = unknown

Runs a gcloud command — the seam gcloudAccessToken resolves the token through. Defaults to "./gcloud.ts".GcloudTasks .run; injectable so the default provider is unit-testable without invoking gcloud.

GcloudRunServicesDescribeSettings

class

class GcloudRunServicesDescribeSettings extends GcloudSettings

Settings for gcloud run services describe.

Member	Signature	Doc
`service`	`service(name: string): this`	The service to describe (positional).
`region`	`region(value: string): this`	The region it runs in (`--region`).
`platform`	`platform(value: string): this`	The platform it runs on (`--platform`).

GcloudRunServicesListSettings

class

class GcloudRunServicesListSettings extends GcloudSettings

Settings for gcloud run services list.

Member	Signature	Doc
`region`	`region(value: string): this`	The region to list from (`--region`).
`platform`	`platform(value: string): this`	The platform to list from (`--platform`).
`filter`	`filter(expression: string): this`	Restrict the listing (`--filter`).

GcloudRunServicesUpdateSettings

class

class GcloudRunServicesUpdateSettings extends GcloudSettings

Settings for gcloud run services update — amending a service that already exists.

Distinct from GcloudRunDeploySettings on purpose. run deploy creates the service when it is absent and resets settings the invocation does not name; run services update only ever amends an existing one. A deploy that points a live service at a freshly built image wants the second guarantee, and getting the first by accident — a service quietly created, or scaling config quietly dropped — is a worse failure than an error.

Member	Signature	Doc
`service`	`service(name: string): this`	The service to update (positional).
`region`	`region(value: string): this`	The region it runs in (`--region`).
`platform`	`platform(value: string): this`	The platform it runs on (`--platform`).
`image`	`image(reference: string): this`	The container image to point the service at (`--image`).
`updateEnvVars`	`updateEnvVars(...pairs: string[]): this`	Set or overwrite environment variables (`--update-env-vars`), as `KEY=value`; repeatable. Variables the call does not name are left alone — which is the difference from `run deploy`'s `--set-env-vars`.
`removeEnvVars`	`removeEnvVars(...names: string[]): this`	Remove environment variables by name (`--remove-env-vars`); repeatable.
`clearEnvVars`	`clearEnvVars(): this`	Remove every environment variable the service has (`--clear-env-vars`).
`updateSecrets`	`updateSecrets(...pairs: string[]): this`	Set or overwrite Secret Manager mounts (`--update-secrets`), as `KEY=secret:version`; repeatable.
`memory`	`memory(value: string): this`	Memory per instance (`--memory`), e.g. `"512Mi"`.
`cpu`	`cpu(value: string): this`	CPU per instance (`--cpu`).
`concurrency`	`concurrency(value: number): this`	Requests served concurrently per instance (`--concurrency`).
`maxInstances`	`maxInstances(value: number): this`	Upper bound on instances (`--max-instances`).
`minInstances`	`minInstances(value: number): this`	Lower bound on instances (`--min-instances`).
`tag`	`tag(value: string): this`	Tag the revision this update creates (`--tag`).
`noTraffic`	`noTraffic(): this`	Create the revision without moving traffic to it (`--no-traffic`).

GcloudRunUpdateTrafficSettings

class

class GcloudRunUpdateTrafficSettings extends GcloudSettings

Settings for gcloud run services update-traffic.

Member	Signature	Doc
`service`	`service(name: string): this`	The service whose traffic to move (positional).
`region`	`region(value: string): this`	The region it runs in (`--region`).
`toLatest`	`toLatest(): this`	Send all traffic to the newest revision (`--to-latest`).
`toRevisions`	`toRevisions(...splits: string[]): this`	Split traffic across revisions (`--to-revisions`), as `rev=percent`.
`toTags`	`toTags(...splits: string[]): this`	Split traffic across tags (`--to-tags`), as `tag=percent`.

GcloudSecretsVersionsAccessSettings

class

class GcloudSecretsVersionsAccessSettings extends GcloudSettings

Settings for gcloud secrets versions access.

Member	Signature	Doc
`version`	`version(value: string): this`	The version to read (positional); defaults to `latest`.
`secret`	`secret(name: string): this`	The secret to read it from (`--secret`).

GcloudSettings

class

class GcloudSettings extends SubcommandSettings

Settings for a gcloud invocation.

Member	Signature	Doc
`containerImagesAddTag`	`containerImagesAddTag(source: string, ...destinations: string[]): this`	Add tags to a container image across registries: `gcloud container images add-tag <source> <destination…>`. Each argument is a discrete argv token, so an image reference can't inject flags. Runs with `--quiet` (the re-tag is non-interactive automation; `add-tag` otherwise prompts for confirmation).
`sqlInstancesDescribe`	`sqlInstancesDescribe(instance: string): this`	Describe a Cloud SQL instance: `gcloud sql instances describe <instance>`. Add `.format("json")` to get a machine-readable body to parse from the command's stdout.
`sqlOperationsWait`	`sqlOperationsWait(operation: string): this`	Block until a Cloud SQL operation completes: `gcloud sql operations wait <operation>` — the typed form of the poll-an-operation shell loop.
`project`	`project(id: string): this`	Target Google Cloud project (`--project`).
`account`	`account(email: string): this`	Account to run as (`--account`).
`configuration`	`configuration(name: string): this`	Named gcloud configuration to use (`--configuration`).
`format`	`format(value: string): this`	Output format, e.g. `json`, `yaml`, `value(name)` (`--format`).
`verbosity`	`verbosity(level: string): this`	Logging verbosity: `debug`, `info`, `warning`, `error`, … (`--verbosity`).
`noPrompt`	`noPrompt(): this`	Disable interactive prompts, accepting defaults (gcloud's `--quiet`). Named `noPrompt` to avoid clashing with the base `.quiet()`, which suppresses Zuke's own output streaming.

GcloudStorageCpSettings

class

class GcloudStorageCpSettings extends GcloudSettings

Settings for gcloud storage cp.

Member	Signature	Doc
`sources`	`sources(...paths: string[]): this`	The sources to copy (positional); repeatable.
`destination`	`destination(path: string): this`	Where to copy them (positional).
`recursive`	`recursive(): this`	Copy directories and their contents (`--recursive`).
`noClobber`	`noClobber(): this`	Skip objects that already exist (`--no-clobber`).
`contentType`	`contentType(value: string): this`	Set the uploaded objects' content type (`--content-type`).
`cacheControl`	`cacheControl(value: string): this`	Set the uploaded objects' cache control (`--cache-control`).

GcloudStorageLsSettings

class

class GcloudStorageLsSettings extends GcloudSettings

Settings for gcloud storage ls.

Member	Signature	Doc
`paths`	`paths(...values: string[]): this`	The paths to list (positional); repeatable.
`recursive`	`recursive(): this`	Recurse into prefixes (`--recursive`).
`long`	`long(): this`	Include size and creation time (`--long`).

GcloudStorageRmSettings

class

class GcloudStorageRmSettings extends GcloudSettings

Settings for gcloud storage rm.

Member	Signature	Doc
`paths`	`paths(...values: string[]): this`	The objects or prefixes to remove (positional); repeatable.
`recursive`	`recursive(): this`	Remove prefixes and everything under them (`--recursive`).

GcloudStorageRsyncSettings

class

class GcloudStorageRsyncSettings extends GcloudSettings

Settings for gcloud storage rsync.

Member	Signature	Doc
`source`	`source(path: string): this`	The source tree (positional).
`destination`	`destination(path: string): this`	The destination tree (positional).
`recursive`	`recursive(): this`	Recurse into directories (`--recursive`).
`deleteUnmatchedDestinationObjects`	`deleteUnmatchedDestinationObjects(): this`	Delete objects at the destination that the source does not have (`--delete-unmatched-destination-objects`), which makes the destination a mirror rather than a superset.
`exclude`	`exclude(pattern: string): this`	Skip paths matching this pattern (`--exclude`).

GcloudTasks

const

const GcloudTasks: GcloudTasksApi

Typed task functions for the gcloud CLI.

GcloudTasksApi

interface

interface GcloudTasksApi

The shape of GcloudTasks.

Member	Signature	Doc
`run`	`run(configure?: Configure<GcloudSettings>): Promise<CommandOutput>`	Run a `gcloud` command.
`authActivateServiceAccount`	`authActivateServiceAccount(configure?: Configure<GcloudAuthActivateServiceAccountSettings>): Promise<CommandOutput>`	Activate a service account: `gcloud auth activate-service-account`.
`authPrintAccessToken`	`authPrintAccessToken(configure?: Configure<GcloudAuthPrintAccessTokenSettings>): Promise<CommandOutput>`	Print an OAuth access token: `gcloud auth print-access-token`.
`accessToken`	`accessToken(configure?: Configure<GcloudAuthPrintAccessTokenSettings>): Promise<string>`	The OAuth access token itself, read back as a string.
`authPrintIdentityToken`	`authPrintIdentityToken(configure?: Configure<GcloudAuthPrintIdentityTokenSettings>): Promise<CommandOutput>`	Print an identity token: `gcloud auth print-identity-token`.
`identityToken`	`identityToken(configure?: Configure<GcloudAuthPrintIdentityTokenSettings>): Promise<string>`	The identity token itself, read back as a string.
`authConfigureDocker`	`authConfigureDocker(configure?: Configure<GcloudAuthConfigureDockerSettings>): Promise<CommandOutput>`	Register gcloud as a Docker credential helper: `gcloud auth configure-docker`.
`authList`	`authList(configure?: Configure<GcloudAuthListSettings>): Promise<CommandOutput>`	List credentialed accounts: `gcloud auth list`.
`authRevoke`	`authRevoke(configure?: Configure<GcloudAuthRevokeSettings>): Promise<CommandOutput>`	Revoke credentials: `gcloud auth revoke`.
`configSet`	`configSet(configure?: Configure<GcloudConfigSetSettings>): Promise<CommandOutput>`	Set a property: `gcloud config set`.
`configUnset`	`configUnset(configure?: Configure<GcloudConfigUnsetSettings>): Promise<CommandOutput>`	Clear a property: `gcloud config unset`.
`configGetValue`	`configGetValue(configure?: Configure<GcloudConfigGetValueSettings>): Promise<CommandOutput>`	Read a property: `gcloud config get-value`.
`configValue`	`configValue(configure?: Configure<GcloudConfigGetValueSettings>): Promise<string>`	A configured property's value, read back as a string.
`configList`	`configList(configure?: Configure<GcloudConfigListSettings>): Promise<CommandOutput>`	List the active configuration: `gcloud config list`.
`buildsSubmit`	`buildsSubmit(configure?: Configure<GcloudBuildsSubmitSettings>): Promise<CommandOutput>`	Submit a Cloud Build: `gcloud builds submit`.
`buildsList`	`buildsList(configure?: Configure<GcloudBuildsListSettings>): Promise<CommandOutput>`	List builds: `gcloud builds list`.
`buildsDescribe`	`buildsDescribe(configure?: Configure<GcloudBuildsDescribeSettings>): Promise<CommandOutput>`	Describe a build: `gcloud builds describe`.
`buildsLog`	`buildsLog(configure?: Configure<GcloudBuildsLogSettings>): Promise<CommandOutput>`	Read a build's log: `gcloud builds log`.
`runDeploy`	`runDeploy(configure?: Configure<GcloudRunDeploySettings>): Promise<CommandOutput>`	Deploy to Cloud Run: `gcloud run deploy`.
`runServicesDescribe`	`runServicesDescribe(configure?: Configure<GcloudRunServicesDescribeSettings>): Promise<CommandOutput>`	Describe a Cloud Run service: `gcloud run services describe`.
`runServiceUrl`	`runServiceUrl(configure?: Configure<GcloudRunServicesDescribeSettings>): Promise<string>`	The URL Cloud Run assigned a service, read back as a string. Pins `--format` to gcloud's own value projection, so gcloud extracts the field.
`runServicesList`	`runServicesList(configure?: Configure<GcloudRunServicesListSettings>): Promise<CommandOutput>`	List Cloud Run services: `gcloud run services list`.
`runServicesUpdate`	`runServicesUpdate(configure?: Configure<GcloudRunServicesUpdateSettings>): Promise<CommandOutput>`	Amend an existing Cloud Run service: `gcloud run services update`. Unlike `runDeploy`, it never creates the service and never resets settings the call does not name.
`runUpdateTraffic`	`runUpdateTraffic(configure?: Configure<GcloudRunUpdateTrafficSettings>): Promise<CommandOutput>`	Move traffic between revisions: `gcloud run services update-traffic`.
`artifactsImagesList`	`artifactsImagesList(configure?: Configure<GcloudArtifactsImagesListSettings>): Promise<CommandOutput>`	List images in Artifact Registry: `gcloud artifacts docker images list`.
`artifactsImagesDelete`	`artifactsImagesDelete(configure?: Configure<GcloudArtifactsImagesDeleteSettings>): Promise<CommandOutput>`	Delete an image: `gcloud artifacts docker images delete`.
`artifactsRepositoriesList`	`artifactsRepositoriesList(configure?: Configure<GcloudArtifactsRepositoriesListSettings>): Promise<CommandOutput>`	List repositories: `gcloud artifacts repositories list`.
`artifactsRepositoriesDescribe`	`artifactsRepositoriesDescribe(configure?: Configure<GcloudArtifactsRepositoriesDescribeSettings>): Promise<CommandOutput>`	Describe a repository: `gcloud artifacts repositories describe`.
`storageCp`	`storageCp(configure?: Configure<GcloudStorageCpSettings>): Promise<CommandOutput>`	Copy to or from Cloud Storage: `gcloud storage cp`.
`storageRsync`	`storageRsync(configure?: Configure<GcloudStorageRsyncSettings>): Promise<CommandOutput>`	Sync a tree to or from Cloud Storage: `gcloud storage rsync`.
`storageLs`	`storageLs(configure?: Configure<GcloudStorageLsSettings>): Promise<CommandOutput>`	List objects: `gcloud storage ls`.
`storageRm`	`storageRm(configure?: Configure<GcloudStorageRmSettings>): Promise<CommandOutput>`	Remove objects: `gcloud storage rm`.
`clustersGetCredentials`	`clustersGetCredentials(configure?: Configure<GcloudClustersGetCredentialsSettings>): Promise<CommandOutput>`	Write a kubeconfig entry for a GKE cluster: `gcloud container clusters get-credentials`.
`clustersList`	`clustersList(configure?: Configure<GcloudClustersListSettings>): Promise<CommandOutput>`	List GKE clusters: `gcloud container clusters list`.
`clustersDescribe`	`clustersDescribe(configure?: Configure<GcloudClustersDescribeSettings>): Promise<CommandOutput>`	Describe a GKE cluster: `gcloud container clusters describe`.
`functionsDeploy`	`functionsDeploy(configure?: Configure<GcloudFunctionsDeploySettings>): Promise<CommandOutput>`	Deploy a Cloud Function: `gcloud functions deploy`.
`functionsDescribe`	`functionsDescribe(configure?: Configure<GcloudFunctionsDescribeSettings>): Promise<CommandOutput>`	Describe a Cloud Function: `gcloud functions describe`.
`secretsAccess`	`secretsAccess(configure?: Configure<GcloudSecretsVersionsAccessSettings>): Promise<CommandOutput>`	Read a secret version: `gcloud secrets versions access`.
`secretValue`	`secretValue(configure?: Configure<GcloudSecretsVersionsAccessSettings>): Promise<string>`	A secret version's payload, read back as a string.

GcpRestOptions

interface

interface GcpRestOptions

Common options for a Google REST call: the bearer token and an injectable fetch.

Member	Signature	Doc
`token`	`token: string`	The OAuth access token (see `"./auth.ts".gcloudAccessToken`).
`fetch?`	`fetch?: fetch`	The `fetch` implementation; defaults to the global. Overridable for tests.

GcsListOptions

interface

interface GcsListOptions

Options for GcsTasksApi.list: the auth/transport plus an object-name prefix.

Member	Signature	Doc
`prefix?`	`prefix?: string`	Keep only objects whose name starts with this prefix.

GcsOptions

interface

interface GcsOptions

Auth + transport options common to every GcsTasks call.

Member	Signature	Doc
`token?`	`token?: string`	A pre-resolved OAuth token; when omitted, `tokenProvider` supplies one.
`tokenProvider?`	`tokenProvider?: AccessTokenProvider`	Resolves the token when `token` is omitted (default: `"./auth.ts".gcloudAccessToken`).
`fetch?`	`fetch?: fetch`	The `fetch` implementation; defaults to the global. Overridable for tests.

GcsTasks

const

const GcsTasks: GcsTasksApi

Typed Google Cloud Storage JSON operations.

GcsTasksApi

interface

interface GcsTasksApi

The shape of GcsTasks.

Member	Signature	Doc
`readJson`	`readJson(bucket: string, object: string, options?: GcsOptions): Promise<T>`	Read object `object` from `bucket` and parse its body as JSON.
`writeJson`	`writeJson(bucket: string, object: string, data: unknown, options?: GcsOptions): Promise<void>`	Write `data` (JSON-serialised) as object `object` in `bucket`.
`list`	`list(bucket: string, options?: GcsListOptions): Promise<string[]>`	List object names in `bucket` (optionally filtered by `prefix`).

resolveAccessToken

function

function resolveAccessToken(options: unknown): Promise<string>

Resolve a bearer token from an explicit token or, when it is omitted, the tokenProvider (defaulting to gcloudAccessToken). Shared by the REST task groups so every call resolves auth the same way.

RUN_SERVICE_URL_FORMAT

const

const RUN_SERVICE_URL_FORMAT: value(status.url)

The --format the service-URL reader pins, so gcloud does the extraction.

SecretManagerAccessOptions

interface

interface SecretManagerAccessOptions

Options for SecretManagerTasksApi.access: the common options plus a version.

Member	Signature	Doc
`version?`	`version?: string`	The version to access; defaults to `"latest"`.

SecretManagerOptions

interface

interface SecretManagerOptions

Auth + transport + project options common to every SecretManagerTasks call.

Member	Signature	Doc
`project?`	`project?: string`	The Google Cloud project id; when omitted, resolved from the environment.
`token?`	`token?: string`	A pre-resolved OAuth token; when omitted, `tokenProvider` supplies one.
`tokenProvider?`	`tokenProvider?: AccessTokenProvider`	Resolves the token when `token` is omitted (default: `"./auth.ts".gcloudAccessToken`).
`fetch?`	`fetch?: fetch`	The `fetch` implementation; defaults to the global. Overridable for tests.
`readEnv?`	`readEnv?: unknown`	Reads an environment variable for project resolution; defaults to `Deno.env.get`.

SecretManagerTasks

const

const SecretManagerTasks: SecretManagerTasksApi

Typed Google Secret Manager operations.

SecretManagerTasksApi

interface

interface SecretManagerTasksApi

The shape of SecretManagerTasks.

Member	Signature	Doc
`access`	`access(name: string, options?: SecretManagerAccessOptions): Promise<string>`	Access secret `name`'s payload as a string (version defaults to `"latest"`).
`addVersion`	`addVersion(name: string, value: string, options?: SecretManagerOptions): Promise<string>`	Add a new version holding `value` to secret `name`, creating the secret first if it does not exist (an already-exists `409` is ignored) — the write-before-create idempotency a deploy relies on. Returns the new version's resource name.