mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-02 17:42:16 +01:00
remove generated libs
This commit is contained in:
OMGeeky
@@ -1,42 +0,0 @@
|
||||
# DO NOT EDIT !
|
||||
# This file was generated automatically from 'src/generator/templates/Cargo.toml.mako'
|
||||
# DO NOT EDIT !
|
||||
[package]
|
||||
|
||||
name = "google-cloudshell1-cli"
|
||||
version = "5.0.4+20240212"
|
||||
authors = ["Sebastian Thiel <byronimo@gmail.com>"]
|
||||
description = "A complete library to interact with Cloud Shell (protocol v1)"
|
||||
repository = "https://github.com/Byron/google-apis-rs/tree/main/gen/cloudshell1-cli"
|
||||
homepage = "https://cloud.google.com/shell/docs/"
|
||||
documentation = "http://byron.github.io/google-apis-rs/google_cloudshell1_cli"
|
||||
license = "MIT"
|
||||
keywords = ["cloudshell", "google", "cli"]
|
||||
autobins = false
|
||||
edition = "2018"
|
||||
|
||||
[[bin]]
|
||||
name = "cloudshell1"
|
||||
path = "src/main.rs"
|
||||
|
||||
[dependencies]
|
||||
anyhow = "^ 1.0"
|
||||
hyper-rustls = "0.24.0"
|
||||
mime = "^ 0.3.0"
|
||||
serde = { version = "^ 1.0", features = ["derive"] }
|
||||
serde_json = "^ 1.0"
|
||||
itertools = "^ 0.10"
|
||||
google-clis-common = { path = "../../google-clis-common", version = "6.0" }
|
||||
strsim = "^0.5"
|
||||
clap = "^2.0"
|
||||
http = "^0.2"
|
||||
hyper = { version = "0.14", features = ["full"] }
|
||||
tokio = { version = "^ 1.0", features = ["full"] }
|
||||
tower-service = "^0.3.1"
|
||||
|
||||
|
||||
|
||||
[dependencies.google-cloudshell1]
|
||||
path = "../cloudshell1"
|
||||
version = "5.0.4+20240212"
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
<!---
|
||||
DO NOT EDIT !
|
||||
This file was generated automatically from 'src/generator/templates/LICENSE.md.mako'
|
||||
DO NOT EDIT !
|
||||
-->
|
||||
The MIT License (MIT)
|
||||
=====================
|
||||
|
||||
Copyright © `2015-2020` `Sebastian Thiel`
|
||||
|
||||
Permission is hereby granted, free of charge, to any person
|
||||
obtaining a copy of this software and associated documentation
|
||||
files (the “Software”), to deal in the Software without
|
||||
restriction, including without limitation the rights to use,
|
||||
copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the
|
||||
Software is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -1,114 +0,0 @@
|
||||
<!---
|
||||
DO NOT EDIT !
|
||||
This file was generated automatically from 'src/generator/templates/cli/README.md.mako'
|
||||
DO NOT EDIT !
|
||||
-->
|
||||
The `cloudshell1` command-line interface *(CLI)* allows to use most features of the *Google Cloud Shell* 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 Shell* API can be found at the
|
||||
[official documentation site](https://cloud.google.com/shell/docs/).
|
||||
|
||||
# Installation and Source Code
|
||||
|
||||
Install the command-line interface with cargo using:
|
||||
|
||||
```bash
|
||||
cargo install google-cloudshell1-cli
|
||||
```
|
||||
|
||||
Find the source code [on github](https://github.com/Byron/google-apis-rs/tree/main/gen/cloudshell1-cli).
|
||||
|
||||
# Usage
|
||||
|
||||
This documentation was generated from the *Cloud Shell* API at revision *20240212*. The CLI is at version *5.0.4*.
|
||||
|
||||
```bash
|
||||
cloudshell1 [options]
|
||||
operations
|
||||
cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
delete <name> [-p <v>]... [-o <out>]
|
||||
get <name> [-p <v>]... [-o <out>]
|
||||
list <name> [-p <v>]... [-o <out>]
|
||||
users
|
||||
environments-add-public-key <environment> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
environments-authorize <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
environments-get <name> [-p <v>]... [-o <out>]
|
||||
environments-remove-public-key <environment> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
environments-start <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
cloudshell1 --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 `cloudshell1-`. 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/cloudshell1-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/cloudshell1-secret.json`, assuming that the required *cloudshell* 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. `cloudshell1 --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/
|
||||
@@ -1,27 +0,0 @@
|
||||
site_name: Cloud Shell v5.0.4+20240212
|
||||
site_url: http://byron.github.io/google-apis-rs/google-cloudshell1-cli
|
||||
site_description: A complete library to interact with Cloud Shell (protocol v1)
|
||||
|
||||
repo_url: https://github.com/Byron/google-apis-rs/tree/main/gen/cloudshell1-cli
|
||||
|
||||
docs_dir: docs
|
||||
site_dir: build_html
|
||||
|
||||
nav:
|
||||
- Home: 'index.md'
|
||||
- 'Operations':
|
||||
- 'Cancel': 'operations_cancel.md'
|
||||
- 'Delete': 'operations_delete.md'
|
||||
- 'Get': 'operations_get.md'
|
||||
- 'List': 'operations_list.md'
|
||||
- 'Users':
|
||||
- 'Environments Add Public Key': 'users_environments-add-public-key.md'
|
||||
- 'Environments Authorize': 'users_environments-authorize.md'
|
||||
- 'Environments Get': 'users_environments-get.md'
|
||||
- 'Environments Remove Public Key': 'users_environments-remove-public-key.md'
|
||||
- 'Environments Start': 'users_environments-start.md'
|
||||
|
||||
theme: readthedocs
|
||||
|
||||
copyright: Copyright © 2015-2020, `Sebastian Thiel`
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user