11[ // ] : # " This README.md file is auto-generated, all changes to this file will be lost. "
2- [ // ] : # " To regenerate it, use `python -m synthtool` ."
2+ [ // ] : # " The comments you see below are used to generate those parts of the template in later states ."
33<img src =" https://avatars2.githubusercontent.com/u/2810941?v=3&s=96 " alt =" Google Cloud Platform logo " title =" Google Cloud Platform " align =" right " height =" 96 " width =" 96 " />
44
5- # [ Cloud Shell: Node.js Client] ( https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-shell )
6-
7- [ ![ release level] ( https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat )] ( https://cloud.google.com/terms/launch-stages )
8- [ ![ npm version] ( https://img.shields.io/npm/v/@google-cloud/shell.svg )] ( https://www.npmjs.org/package/@google-cloud/shell )
9-
5+ # [ Cloud Shell API: Nodejs Client] [ homepage ]
106
7+ This library is considered to be ** stable** . The code surface will not change in backwards-incompatible ways
8+ unless absolutely necessary (e.g. because of critical security issues) or with
9+ an extensive deprecation period. Issues and requests against ** stable** libraries
10+ are addressed with the highest priority
1111
12+ [ ![ npm version] ( https://img.shields.io/npm/v/@google-cloud/shell.svg )] ( https://www.npmjs.org/package/@google-cloud/shell )
1213
13- cloudshell client for Node.js
14+ Cloud Shell API client for Node.js
1415
16+ [ // ] : # " partials.introduction "
1517
1618A comprehensive list of changes in each version may be found in
17- [ the CHANGELOG] ( https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-shell/CHANGELOG.md ) .
19+ [ the CHANGELOG] [ homepage_changelog ] .
20+
21+ * [ Cloud Shell API Nodejs Client API Reference] ( https://cloud.google.com/nodejs/docs/reference/shell/latest )
1822
19- * [ Cloud Shell Node.js Client API Reference] [ client-docs ]
20- * [ Cloud Shell Documentation] [ product-docs ]
21- * [ github.com/googleapis/google-cloud-node/packages/google-cloud-shell] ( https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-shell )
2223
2324Read more about the client libraries for Cloud APIs, including the older
2425Google APIs Client Libraries, in [ Client Libraries Explained] [ explained ] .
@@ -27,77 +28,43 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
2728
2829** Table of contents:**
2930
30-
3131* [ Quickstart] ( #quickstart )
3232 * [ Before you begin] ( #before-you-begin )
3333 * [ Installing the client library] ( #installing-the-client-library )
34- * [ Using the client library] ( #using-the-client-library )
35- * [ Samples] ( #samples )
34+
3635* [ Versioning] ( #versioning )
3736* [ Contributing] ( #contributing )
3837* [ License] ( #license )
3938
4039## Quickstart
41-
4240### Before you begin
4341
44421 . [ Select or create a Cloud Platform project] [ projects ] .
45431 . [ Enable billing for your project] [ billing ] .
46- 1 . [ Enable the Cloud Shell API] [ enable_api ] .
44+ 1 . [ Enable the Cloud Shell API API ] [ enable_api ] .
47451 . [ Set up authentication] [ auth ] so you can access the
4846 API from your local workstation.
49-
5047### Installing the client library
5148
5249``` bash
5350npm install @google-cloud/shell
5451```
5552
56-
57- ### Using the client library
58-
59- ``` javascript
60- // Imports the Google Cloud client library
61-
62- // remove this line after package is released
63- // eslint-disable-next-line node/no-missing-require
64- const {CloudShellServiceClient } = require (' @google-cloud/shell' );
65-
66- // TODO(developer): replace with your prefered project ID.
67- // const projectId = 'my-project'
68-
69- // Creates a client
70- // eslint-disable-next-line no-unused-vars
71- const client = new CloudShellServiceClient ();
72-
73- // TODO(library generator): write the actual function you will be testing
74- async function initializeClient () {
75- const operation = await client .initialize ();
76- console .info (operation);
77- }
78- initializeClient ();
79-
80- ```
81-
82-
53+ [ // ] : # " partials.body "
8354
8455## Samples
8556
86- Samples are in the [ ` samples/ ` ] ( https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-shell/samples ) directory. Each sample's ` README.md ` has instructions for running its sample.
87-
88- | Sample | Source Code | Try it |
89- | --------------------------- | --------------------------------- | ------ |
90- | Cloud_shell_service.add_public_key | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.add_public_key.js ) | [ ![ Open in Cloud Shell] [ shell_img ]] ( https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.add_public_key.js,packages/google-cloud-shell/samples/README.md ) |
91- | Cloud_shell_service.authorize_environment | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.authorize_environment.js ) | [ ![ Open in Cloud Shell] [ shell_img ]] ( https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.authorize_environment.js,packages/google-cloud-shell/samples/README.md ) |
92- | Cloud_shell_service.get_environment | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.get_environment.js ) | [ ![ Open in Cloud Shell] [ shell_img ]] ( https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.get_environment.js,packages/google-cloud-shell/samples/README.md ) |
93- | Cloud_shell_service.remove_public_key | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.remove_public_key.js ) | [ ![ Open in Cloud Shell] [ shell_img ]] ( https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.remove_public_key.js,packages/google-cloud-shell/samples/README.md ) |
94- | Cloud_shell_service.start_environment | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.start_environment.js ) | [ ![ Open in Cloud Shell] [ shell_img ]] ( https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.start_environment.js,packages/google-cloud-shell/samples/README.md ) |
95- | Quickstart | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/quickstart.js ) | [ ![ Open in Cloud Shell] [ shell_img ]] ( https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-shell/samples/quickstart.js,packages/google-cloud-shell/samples/README.md ) |
96-
57+ Samples are in the [ ` samples/ ` ] [ homepage_samples ] directory. Each sample's ` README.md ` has instructions for running its sample.
9758
59+ | Sample | Source Code |
60+ | --------------------------- | --------------------------------- |
61+ | add public key | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.add_public_key.js ) |
62+ | authorize environment | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.authorize_environment.js ) |
63+ | get environment | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.get_environment.js ) |
64+ | remove public key | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.remove_public_key.js ) |
65+ | start environment | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/cloud_shell_service.start_environment.js ) |
66+ | cloud | [ source code] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples/generated/v1/snippet_metadata_google.cloud.shell.v1.json ) |
9867
99- The [ Cloud Shell Node.js Client API Reference] [ client-docs ] documentation
100- also contains samples.
10168
10269## Supported Node.js Versions
10370
@@ -124,45 +91,29 @@ for versions compatible with Node.js 8.
12491
12592This library follows [ Semantic Versioning] ( http://semver.org/ ) .
12693
127-
128-
129- This library is considered to be ** stable** . The code surface will not change in backwards-incompatible ways
130- unless absolutely necessary (e.g. because of critical security issues) or with
131- an extensive deprecation period. Issues and requests against ** stable** libraries
132- are addressed with the highest priority.
133-
134-
135-
136-
137-
138-
13994More Information: [ Google Cloud Platform Launch Stages] [ launch_stages ]
14095
14196[ launch_stages ] : https://cloud.google.com/terms/launch-stages
14297
14398## Contributing
14499
145- Contributions welcome! See the [ Contributing Guide] ( https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md ) .
100+ Contributions welcome! See the [ Contributing Guide] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/ CONTRIBUTING.md ) .
146101
147- Please note that this ` README.md ` , the ` samples/README.md ` ,
102+ Please note that this ` README.md `
148103and a variety of configuration files in this repository (including ` .nycrc ` and ` tsconfig.json ` )
149- are generated from a central template. To edit one of these files, make an edit
150- to its templates in
151- [ directory] ( https://github.com/googleapis/synthtool ) .
104+ are generated from a central template.
152105
153106## License
154107
155108Apache Version 2.0
156109
157- See [ LICENSE] ( https://github.com/googleapis/google-cloud-node/blob/main/LICENSE )
110+ See [ LICENSE] ( https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/ LICENSE )
158111
159- [ client-docs ] : https://cloud.google.com/nodejs/docs/reference/shell/latest
160- [ product-docs ] : https://cloud.google.com/shell/
161112[ shell_img ] : https://gstatic.com/cloudssh/images/open-btn.png
162113[ projects ] : https://console.cloud.google.com/project
163114[ billing ] : https://support.google.com/cloud/answer/6293499#enable-billing
164115[ enable_api ] : https://console.cloud.google.com/flows/enableapi?apiid=cloudshell.googleapis.com
165116[ auth ] : https://cloud.google.com/docs/authentication/external/set-up-adc-local
166-
167-
168- [ // ] : # " partials.introduction "
117+ [ homepage_samples ] : https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/samples
118+ [ homepage_changelog ] : https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell/CHANGELOG.md
119+ [ homepage ] : https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-shell
0 commit comments