From 616799094c52afb9a1d98216ebc1af052ad109d8 Mon Sep 17 00:00:00 2001 From: kekwlboy12469 Date: Mon, 6 Oct 2025 01:49:10 +0530 Subject: [PATCH 1/2] ibmcloud-{api,config,logout,regions,target}: add pages Add tldr pages for IBM Cloud CLI core commands (Part 1 of 3). These are the fundamental commands for API endpoint configuration, CLI settings, authentication, and targeting resources. Split from original PR #18442 as requested by maintainer. --- pages/common/ibmcloud-api.md | 28 ++++++++++++++++++++++++++++ pages/common/ibmcloud-config.md | 28 ++++++++++++++++++++++++++++ pages/common/ibmcloud-logout.md | 8 ++++++++ pages/common/ibmcloud-regions.md | 8 ++++++++ pages/common/ibmcloud-target.md | 28 ++++++++++++++++++++++++++++ 5 files changed, 100 insertions(+) create mode 100644 pages/common/ibmcloud-api.md create mode 100644 pages/common/ibmcloud-config.md create mode 100644 pages/common/ibmcloud-logout.md create mode 100644 pages/common/ibmcloud-regions.md create mode 100644 pages/common/ibmcloud-target.md diff --git a/pages/common/ibmcloud-api.md b/pages/common/ibmcloud-api.md new file mode 100644 index 00000000000000..2535c65e2cb8bf --- /dev/null +++ b/pages/common/ibmcloud-api.md @@ -0,0 +1,28 @@ +# ibmcloud api + +> Set or view the IBM Cloud API endpoint. +> More information: . + +- View the current API endpoint: + +`ibmcloud api` + +- Set the API endpoint to cloud.ibm.com: + +`ibmcloud api cloud.ibm.com` + +- Set a private API endpoint: + +`ibmcloud api private.cloud.ibm.com` + +- Use a VPC connection for a private endpoint: + +`ibmcloud api private.cloud.ibm.com --vpc` + +- Bypass SSL validation of HTTP requests: + +`ibmcloud api https://cloud.ibm.com --skip-ssl-validation` + +- Remove the API endpoint setting: + +`ibmcloud api --unset` diff --git a/pages/common/ibmcloud-config.md b/pages/common/ibmcloud-config.md new file mode 100644 index 00000000000000..49e51d836bee0f --- /dev/null +++ b/pages/common/ibmcloud-config.md @@ -0,0 +1,28 @@ +# ibmcloud config + +> Modify or read out values in the IBM Cloud CLI configuration. +> More information: . + +- Set HTTP request timeout to 30 seconds: + +`ibmcloud config --http-timeout 30` + +- Enable trace output for HTTP requests: + +`ibmcloud config --trace true` + +- Trace HTTP requests to a specific file: + +`ibmcloud config --trace {{path/to/trace_file}}` + +- Disable color output: + +`ibmcloud config --color false` + +- Set the locale to a specific language: + +`ibmcloud config --locale {{zh_Hans}}` + +- Enable automatic SSO one-time passcode acceptance: + +`ibmcloud config --sso-otp auto` diff --git a/pages/common/ibmcloud-logout.md b/pages/common/ibmcloud-logout.md new file mode 100644 index 00000000000000..bbf853ff2fea3c --- /dev/null +++ b/pages/common/ibmcloud-logout.md @@ -0,0 +1,8 @@ +# ibmcloud logout + +> Log out of the IBM Cloud CLI. +> More information: . + +- Log out of the current session: + +`ibmcloud logout` diff --git a/pages/common/ibmcloud-regions.md b/pages/common/ibmcloud-regions.md new file mode 100644 index 00000000000000..b78362424f2949 --- /dev/null +++ b/pages/common/ibmcloud-regions.md @@ -0,0 +1,8 @@ +# ibmcloud regions + +> List all available regions on IBM Cloud. +> More information: . + +- View information for all regions: + +`ibmcloud regions` diff --git a/pages/common/ibmcloud-target.md b/pages/common/ibmcloud-target.md new file mode 100644 index 00000000000000..bee8f6246d4539 --- /dev/null +++ b/pages/common/ibmcloud-target.md @@ -0,0 +1,28 @@ +# ibmcloud target + +> Set or view the target account, region, or resource group. +> More information: . + +- View the current target account and region: + +`ibmcloud target` + +- Set the target account: + +`ibmcloud target -c {{account_id}}` + +- Switch to a specific region: + +`ibmcloud target -r {{region_name}}` + +- Set the target resource group: + +`ibmcloud target -g {{resource_group_name}}` + +- Clear the targeted region: + +`ibmcloud target --unset-region` + +- Clear the targeted resource group: + +`ibmcloud target --unset-resource-group` From 8d26632148027e881b3d9d38100dde5493dfe90a Mon Sep 17 00:00:00 2001 From: kekwlboy12469 Date: Mon, 6 Oct 2025 09:01:00 +0530 Subject: [PATCH 2/2] Update pages/common/ibmcloud-api.md Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> --- pages/common/ibmcloud-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/common/ibmcloud-api.md b/pages/common/ibmcloud-api.md index 2535c65e2cb8bf..ce6a183ae63770 100644 --- a/pages/common/ibmcloud-api.md +++ b/pages/common/ibmcloud-api.md @@ -7,7 +7,7 @@ `ibmcloud api` -- Set the API endpoint to cloud.ibm.com: +- Set the API endpoint to `cloud.ibm.com`: `ibmcloud api cloud.ibm.com`