diff --git a/pages/common/ibmcloud-account.md b/pages/common/ibmcloud-account.md new file mode 100644 index 00000000000000..d77d52f7f0ea98 --- /dev/null +++ b/pages/common/ibmcloud-account.md @@ -0,0 +1,24 @@ +# ibmcloud account + +> Manage IBM Cloud accounts and users. +> More information: . + +- List all accounts: + +`ibmcloud account list` + +- Show details of the current account: + +`ibmcloud account show` + +- List users in the account: + +`ibmcloud account users` + +- Invite a user to the account: + +`ibmcloud account user-invite {{email}}` + +- List organizations in the account: + +`ibmcloud account orgs` diff --git a/pages/common/ibmcloud-api.md b/pages/common/ibmcloud-api.md new file mode 100644 index 00000000000000..ecceff2d6fbf24 --- /dev/null +++ b/pages/common/ibmcloud-api.md @@ -0,0 +1,24 @@ +# 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` + +- Remove the API endpoint setting: + +`ibmcloud api --unset` diff --git a/pages/common/ibmcloud-assist.md b/pages/common/ibmcloud-assist.md new file mode 100644 index 00000000000000..ed230bc75e6740 --- /dev/null +++ b/pages/common/ibmcloud-assist.md @@ -0,0 +1,8 @@ +# ibmcloud assist + +> Get answers to IBM Cloud questions using AI assistant powered by watsonx. +> More information: . + +- Ask a question to the AI assistant: + +`ibmcloud assist "{{How do I create a Kubernetes cluster?}}"` diff --git a/pages/common/ibmcloud-billing.md b/pages/common/ibmcloud-billing.md new file mode 100644 index 00000000000000..2bf70d34efa60f --- /dev/null +++ b/pages/common/ibmcloud-billing.md @@ -0,0 +1,24 @@ +# ibmcloud billing + +> Retrieve usage and billing information for IBM Cloud. +> More information: . + +- View account usage: + +`ibmcloud billing account-usage` + +- View resource group usage: + +`ibmcloud billing resource-group-usage {{resource_group_name}}` + +- View organization usage: + +`ibmcloud billing org-usage {{org_name}}` + +- View resource instances usage: + +`ibmcloud billing resource-instances-usage` + +- View billing information for a specific month: + +`ibmcloud billing account-usage -d {{YYYY-MM}}` diff --git a/pages/common/ibmcloud-catalog.md b/pages/common/ibmcloud-catalog.md new file mode 100644 index 00000000000000..71dc70ab60732c --- /dev/null +++ b/pages/common/ibmcloud-catalog.md @@ -0,0 +1,24 @@ +# ibmcloud catalog + +> Manage the IBM Cloud catalog. +> More information: . + +- List all catalog entries: + +`ibmcloud catalog search` + +- Search for a specific service: + +`ibmcloud catalog search {{service_name}}` + +- Get details of a catalog entry: + +`ibmcloud catalog entry {{entry_id}}` + +- List all templates: + +`ibmcloud catalog templates` + +- Filter catalog by category: + +`ibmcloud catalog search --category {{compute}}` diff --git a/pages/common/ibmcloud-cbr.md b/pages/common/ibmcloud-cbr.md new file mode 100644 index 00000000000000..7cf7a61f408af9 --- /dev/null +++ b/pages/common/ibmcloud-cbr.md @@ -0,0 +1,24 @@ +# ibmcloud cbr + +> Manage Context Based Restrictions in IBM Cloud. +> More information: . + +- List all network zones: + +`ibmcloud cbr zones` + +- Create a network zone: + +`ibmcloud cbr zone-create --name {{zone_name}}` + +- List all context-based restriction rules: + +`ibmcloud cbr rules` + +- Create a context-based restriction rule: + +`ibmcloud cbr rule-create` + +- Delete a network zone: + +`ibmcloud cbr zone-delete {{zone_id}}` 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-help.md b/pages/common/ibmcloud-help.md new file mode 100644 index 00000000000000..6b1c0dd811143d --- /dev/null +++ b/pages/common/ibmcloud-help.md @@ -0,0 +1,16 @@ +# ibmcloud help + +> Display help information for IBM Cloud CLI commands. +> More information: . + +- Display general help for the IBM Cloud CLI: + +`ibmcloud help` + +- Display help for a specific command: + +`ibmcloud help {{command}}` + +- Display help for a specific namespace: + +`ibmcloud help {{namespace}}` 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-plugin.md b/pages/common/ibmcloud-plugin.md new file mode 100644 index 00000000000000..a77844d13524e3 --- /dev/null +++ b/pages/common/ibmcloud-plugin.md @@ -0,0 +1,28 @@ +# ibmcloud plugin + +> Manage plugins and plugin repositories for the IBM Cloud CLI. +> More information: . + +- List all installed plugins: + +`ibmcloud plugin list` + +- Install a plugin from a repository: + +`ibmcloud plugin install {{plugin_name}}` + +- Uninstall a plugin: + +`ibmcloud plugin uninstall {{plugin_name}}` + +- Update all plugins: + +`ibmcloud plugin update --all` + +- List available plugins in repositories: + +`ibmcloud plugin repo-plugins` + +- Add a plugin repository: + +`ibmcloud plugin repo-add {{repo_name}} {{repo_url}}` 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` diff --git a/pages/common/ibmcloud-update.md b/pages/common/ibmcloud-update.md new file mode 100644 index 00000000000000..682409347d801b --- /dev/null +++ b/pages/common/ibmcloud-update.md @@ -0,0 +1,12 @@ +# ibmcloud update + +> Update the IBM Cloud CLI to the most recent version. +> More information: . + +- Update the CLI: + +`ibmcloud update` + +- Force an update without confirmation: + +`ibmcloud update -f` diff --git a/pages/common/ibmcloud-version.md b/pages/common/ibmcloud-version.md new file mode 100644 index 00000000000000..758adf128ec6ab --- /dev/null +++ b/pages/common/ibmcloud-version.md @@ -0,0 +1,8 @@ +# ibmcloud version + +> Print the version of the IBM Cloud CLI. +> More information: . + +- Display the CLI version: + +`ibmcloud version`