An idiomatic C++ client library for theCloud Shell API, a service to allow users to start, configure, and connect to interactive shell sessions running in the cloud.
While this library isGA, please note Google Cloud C++ client libraries donotfollowSemantic Versioning.
Quickstart
The following shows the code that you'll run in thegoogle/cloud/shell/quickstart/directory, which should give you a taste of the Cloud Shell API C++ client library API.
#include "google/cloud/shell/v1/cloud_shell_client.h"
#include <iostream>
#include <string>
int main(int argc, char* argv[]) try {
if (argc != 2) {
std::cerr << "Usage: " << argv[0] << " user\n";
return 1;
}
namespace shell = ::google::cloud::shell_v1;
auto client =
shell::CloudShellServiceClient(shell::MakeCloudShellServiceConnection());
auto const name = "users/" + std::string{argv[1]} + "/environments/default";
auto env = client.GetEnvironment(name);
if (!env) throw std::move(env).status();
std::cout << env->DebugString() << "\n";
return 0;
} catch (google::cloud::Status const& status) {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
Main classes
The main class in this library isshell_v1::CloudShellServiceClient. All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mockshell_v1::CloudShellServiceClientwhen testing your application.
More Information
Error Handling- describes how the library reports errors.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThe latest release candidate for the Cloud Shell API C++ Client Library is version 2.37.0-rc, with multiple prior versions available, ranging down to 2.11.0.\u003c/p\u003e\n"],["\u003cp\u003eThis library provides C++ developers with an idiomatic interface to interact with the Cloud Shell API, allowing them to start, configure, and connect to interactive shell sessions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eshell_v1::CloudShellServiceClient\u003c/code\u003e class is the central point of interaction for making Remote Procedure Calls (RPCs) to the Cloud Shell API.\u003c/p\u003e\n"],["\u003cp\u003eThe Cloud Shell API C++ client library does not follow semantic versioning, despite being in General Availability (GA).\u003c/p\u003e\n"],["\u003cp\u003eThe library provides guidance on how to customize its behavior, including error handling, overriding endpoints and authentication, and adjusting retry policies, and also outlines environment variables that can be used for configuration.\u003c/p\u003e\n"]]],[],null,["Version 2.21.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/shell/latest)\n- [2.41.0](/cpp/docs/reference/shell/2.41.0)\n- [2.40.0](/cpp/docs/reference/shell/2.40.0)\n- [2.39.0](/cpp/docs/reference/shell/2.39.0)\n- [2.38.0](/cpp/docs/reference/shell/2.38.0)\n- [2.37.0](/cpp/docs/reference/shell/2.37.0)\n- [2.36.0](/cpp/docs/reference/shell/2.36.0)\n- [2.35.0](/cpp/docs/reference/shell/2.35.0)\n- [2.34.0](/cpp/docs/reference/shell/2.34.0)\n- [2.33.0](/cpp/docs/reference/shell/2.33.0)\n- [2.32.0](/cpp/docs/reference/shell/2.32.0)\n- [2.31.0](/cpp/docs/reference/shell/2.31.0)\n- [2.30.0](/cpp/docs/reference/shell/2.30.0)\n- [2.29.0](/cpp/docs/reference/shell/2.29.0)\n- [2.28.0](/cpp/docs/reference/shell/2.28.0)\n- [2.27.0](/cpp/docs/reference/shell/2.27.0)\n- [2.26.0](/cpp/docs/reference/shell/2.26.0)\n- [2.25.1](/cpp/docs/reference/shell/2.25.1)\n- [2.24.0](/cpp/docs/reference/shell/2.24.0)\n- [2.23.0](/cpp/docs/reference/shell/2.23.0)\n- [2.22.1](/cpp/docs/reference/shell/2.22.1)\n- [2.21.0](/cpp/docs/reference/shell/2.21.0)\n- [2.20.0](/cpp/docs/reference/shell/2.20.0)\n- [2.19.0](/cpp/docs/reference/shell/2.19.0)\n- [2.18.0](/cpp/docs/reference/shell/2.18.0)\n- [2.17.0](/cpp/docs/reference/shell/2.17.0)\n- [2.16.0](/cpp/docs/reference/shell/2.16.0)\n- [2.15.1](/cpp/docs/reference/shell/2.15.1)\n- [2.14.0](/cpp/docs/reference/shell/2.14.0)\n- [2.13.0](/cpp/docs/reference/shell/2.13.0)\n- [2.12.0](/cpp/docs/reference/shell/2.12.0)\n- [2.11.0](/cpp/docs/reference/shell/2.11.0) \n\nCloud Shell API C++ Client Library\n==================================\n\nAn idiomatic C++ client library for the [Cloud Shell API](https://cloud.google.com/shell), a service to allow users to start, configure, and connect to interactive shell sessions running in the cloud.\n\nWhile this library is **GA** , please note Google Cloud C++ client libraries do **not** follow [Semantic Versioning](https://semver.org/).\n\n### Quickstart\n\nThe following shows the code that you'll run in the `google/cloud/shell/quickstart/` directory, which should give you a taste of the Cloud Shell API C++ client library API. \n\n #include \"google/cloud/shell/v1/cloud_shell_client.h\"\n #include \u003ciostream\u003e\n #include \u003cstring\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 2) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" user\\n\";\n return 1;\n }\n\n namespace shell = ::google::cloud::shell_v1;\n auto client =\n shell::CloudShellServiceClient(shell::MakeCloudShellServiceConnection());\n\n auto const name = \"users/\" + std::string{argv[1]} + \"/environments/default\";\n auto env = client.GetEnvironment(name);\n if (!env) throw std::move(env).status();\n std::cout \u003c\u003c env-\u003eDebugString() \u003c\u003c \"\\n\";\n\n return 0;\n } catch (google::cloud::Status const& status) {\n std::cerr \u003c\u003c \"google::cloud::Status thrown: \" \u003c\u003c status \u003c\u003c \"\\n\";\n return 1;\n }\n\n### Main classes\n\nThe main class in this library is [`shell_v1::CloudShellServiceClient`](/cpp/docs/reference/shell/2.21.0/classgoogle_1_1cloud_1_1shell__v1_1_1CloudShellServiceClient). All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock [`shell_v1::CloudShellServiceClient`](/cpp/docs/reference/shell/2.21.0/classgoogle_1_1cloud_1_1shell__v1_1_1CloudShellServiceClient) when testing your application.\n\n### More Information\n\n- [Error Handling](https://cloud.google.com/cpp/docs/reference/common/latest/common-error-handling.html) - describes how the library reports errors.\n- [How to Override the Default Endpoint](/cpp/docs/reference/shell/2.21.0/shell-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/shell/2.21.0/shell-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Override Retry, Backoff, and Idempotency Policies](/cpp/docs/reference/shell/2.21.0/shell-override-retry) - describes how to change the default retry policies.\n- [Environment Variables](/cpp/docs/reference/shell/2.21.0/shell-env) - describes environment variables that can configure the behavior of the library."]]