mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2025-12-29 23:55:52 +01:00
174 lines
10 KiB
Markdown
174 lines
10 KiB
Markdown
<!---
|
|
DO NOT EDIT !
|
|
This file was generated automatically from 'src/generator/templates/cli/README.md.mako'
|
|
DO NOT EDIT !
|
|
-->
|
|
The `cloudbuild1` command-line interface *(CLI)* allows to use most features of the *Google Cloud Build* service from the comfort of your terminal.
|
|
|
|
By default all output is printed to standard out, but flags can be set to direct it into a file independent of your shell's
|
|
capabilities. Errors will be printed to standard error, and cause the program's exit code to be non-zero.
|
|
|
|
If data-structures are requested, these will be returned as pretty-printed JSON, to be useful as input to other tools.
|
|
|
|
Everything else about the *Cloud Build* API can be found at the
|
|
[official documentation site](https://cloud.google.com/cloud-build/docs/).
|
|
|
|
# Installation and Source Code
|
|
|
|
Install the command-line interface with cargo using:
|
|
|
|
```bash
|
|
cargo install google-cloudbuild1-cli
|
|
```
|
|
|
|
Find the source code [on github](https://github.com/Byron/google-apis-rs/tree/main/gen/cloudbuild1-cli).
|
|
|
|
# Usage
|
|
|
|
This documentation was generated from the *Cloud Build* API at revision *20240223*. The CLI is at version *5.0.4*.
|
|
|
|
```bash
|
|
cloudbuild1 [options]
|
|
github-dot-com-webhook
|
|
receive (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations
|
|
regional-webhook <location> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
methods
|
|
webhook (-r <kv>)... [-p <v>]... [-o <out>]
|
|
operations
|
|
cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
get <name> [-p <v>]... [-o <out>]
|
|
projects
|
|
builds-approve <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
builds-cancel <project-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
builds-create <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
builds-get <project-id> <id> [-p <v>]... [-o <out>]
|
|
builds-list <project-id> [-p <v>]... [-o <out>]
|
|
builds-retry <project-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
github-enterprise-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
github-enterprise-configs-delete <name> [-p <v>]... [-o <out>]
|
|
github-enterprise-configs-get <name> [-p <v>]... [-o <out>]
|
|
github-enterprise-configs-list <parent> [-p <v>]... [-o <out>]
|
|
github-enterprise-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-bitbucket-server-configs-connected-repositories-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-bitbucket-server-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-bitbucket-server-configs-delete <name> [-p <v>]... [-o <out>]
|
|
locations-bitbucket-server-configs-get <name> [-p <v>]... [-o <out>]
|
|
locations-bitbucket-server-configs-list <parent> [-p <v>]... [-o <out>]
|
|
locations-bitbucket-server-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-bitbucket-server-configs-remove-bitbucket-server-connected-repository <config> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-bitbucket-server-configs-repos-list <parent> [-p <v>]... [-o <out>]
|
|
locations-builds-approve <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-builds-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-builds-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-builds-get <name> [-p <v>]... [-o <out>]
|
|
locations-builds-list <parent> [-p <v>]... [-o <out>]
|
|
locations-builds-retry <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-get-default-service-account <name> [-p <v>]... [-o <out>]
|
|
locations-git-lab-configs-connected-repositories-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-git-lab-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-git-lab-configs-delete <name> [-p <v>]... [-o <out>]
|
|
locations-git-lab-configs-get <name> [-p <v>]... [-o <out>]
|
|
locations-git-lab-configs-list <parent> [-p <v>]... [-o <out>]
|
|
locations-git-lab-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-git-lab-configs-remove-git-lab-connected-repository <config> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-git-lab-configs-repos-list <parent> [-p <v>]... [-o <out>]
|
|
locations-github-enterprise-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-github-enterprise-configs-delete <name> [-p <v>]... [-o <out>]
|
|
locations-github-enterprise-configs-get <name> [-p <v>]... [-o <out>]
|
|
locations-github-enterprise-configs-list <parent> [-p <v>]... [-o <out>]
|
|
locations-github-enterprise-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-operations-get <name> [-p <v>]... [-o <out>]
|
|
locations-triggers-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-triggers-delete <name> [-p <v>]... [-o <out>]
|
|
locations-triggers-get <name> [-p <v>]... [-o <out>]
|
|
locations-triggers-list <parent> [-p <v>]... [-o <out>]
|
|
locations-triggers-patch <resource-name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-triggers-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-triggers-webhook <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-worker-pools-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-worker-pools-delete <name> [-p <v>]... [-o <out>]
|
|
locations-worker-pools-get <name> [-p <v>]... [-o <out>]
|
|
locations-worker-pools-list <parent> [-p <v>]... [-o <out>]
|
|
locations-worker-pools-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
triggers-create <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
triggers-delete <project-id> <trigger-id> [-p <v>]... [-o <out>]
|
|
triggers-get <project-id> <trigger-id> [-p <v>]... [-o <out>]
|
|
triggers-list <project-id> [-p <v>]... [-o <out>]
|
|
triggers-patch <project-id> <trigger-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
triggers-run <project-id> <trigger-id> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
triggers-webhook <project-id> <trigger> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
cloudbuild1 --help
|
|
|
|
Configuration:
|
|
[--scope <url>]...
|
|
Specify the authentication a method should be executed in. Each scope
|
|
requires the user to grant this application permission to use it.
|
|
If unset, it defaults to the shortest scope url for a particular method.
|
|
--config-dir <folder>
|
|
A directory into which we will store our persistent data. Defaults to
|
|
a user-writable directory that we will create during the first invocation.
|
|
[default: ~/.google-service-cli]
|
|
|
|
```
|
|
|
|
# Configuration
|
|
|
|
The program will store all persistent data in the `~/.google-service-cli` directory in *JSON* files prefixed with `cloudbuild1-`. You can change the directory used to store configuration with the `--config-dir` flag on a per-invocation basis.
|
|
|
|
More information about the various kinds of persistent data are given in the following paragraphs.
|
|
|
|
# Authentication
|
|
|
|
Most APIs require a user to authenticate any request. If this is the case, the [scope][scopes] determines the
|
|
set of permissions granted. The granularity of these is usually no more than *read-only* or *full-access*.
|
|
|
|
If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a
|
|
method that is read-only, it will ask only for a read-only scope.
|
|
You may use the `--scope` flag to specify a scope directly.
|
|
All applicable scopes are documented in the respective method's CLI documentation.
|
|
|
|
The first time a scope is used, the user is asked for permission. Follow the instructions given
|
|
by the CLI to grant permissions, or to decline.
|
|
|
|
If a scope was authenticated by the user, the respective information will be stored as *JSON* in the configuration
|
|
directory, e.g. `~/.google-service-cli/cloudbuild1-token-<scope-hash>.json`. No manual management of these tokens
|
|
is necessary.
|
|
|
|
To revoke granted authentication, please refer to the [official documentation][revoke-access].
|
|
|
|
# Application Secrets
|
|
|
|
In order to allow any application to use Google services, it will need to be registered using the
|
|
[Google Developer Console][google-dev-console]. APIs the application may use are then enabled for it
|
|
one by one. Most APIs can be used for free and have a daily quota.
|
|
|
|
To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI
|
|
comes with a default application secret that is configured accordingly. This also means that heavy usage
|
|
all around the world may deplete the daily quota.
|
|
|
|
You can workaround this limitation by putting your own secrets file at this location:
|
|
`~/.google-service-cli/cloudbuild1-secret.json`, assuming that the required *cloudbuild* API
|
|
was enabled for it. Such a secret file can be downloaded in the *Google Developer Console* at
|
|
*APIs & auth -> Credentials -> Download JSON* and used as is.
|
|
|
|
Learn more about how to setup Google projects and enable APIs using the [official documentation][google-project-new].
|
|
|
|
|
|
# Debugging
|
|
|
|
Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know
|
|
what exactly led to a particular issue. This is done by allowing all client-server communication to be
|
|
output to standard error *as-is*.
|
|
|
|
The `--debug` flag will print errors using the `Debug` representation to standard error.
|
|
|
|
You may consider redirecting standard error into a file for ease of use, e.g. `cloudbuild1 --debug <resource> <method> [options] 2>debug.txt`.
|
|
|
|
|
|
[scopes]: https://developers.google.com/+/api/oauth#scopes
|
|
[revoke-access]: http://webapps.stackexchange.com/a/30849
|
|
[google-dev-console]: https://console.developers.google.com/
|
|
[google-project-new]: https://developers.google.com/console/help/new/
|