Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions pages/common/ibmcloud-account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# ibmcloud account

> Manage IBM Cloud accounts and users.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_commands_account>.

- 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`
24 changes: 24 additions & 0 deletions pages/common/ibmcloud-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# ibmcloud api

> Set or view the IBM Cloud API endpoint.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_api>.

- 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`
8 changes: 8 additions & 0 deletions pages/common/ibmcloud-assist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ibmcloud assist

> Get answers to IBM Cloud questions using AI assistant powered by watsonx.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_assist>.

- Ask a question to the AI assistant:

`ibmcloud assist "{{How do I create a Kubernetes cluster?}}"`
24 changes: 24 additions & 0 deletions pages/common/ibmcloud-billing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# ibmcloud billing

> Retrieve usage and billing information for IBM Cloud.
> More information: <https://cloud.ibm.com/docs/account?topic=account-ibmcloud_billing>.

- 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}}`
24 changes: 24 additions & 0 deletions pages/common/ibmcloud-catalog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# ibmcloud catalog

> Manage the IBM Cloud catalog.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_catalog>.

- 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}}`
24 changes: 24 additions & 0 deletions pages/common/ibmcloud-cbr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# ibmcloud cbr

> Manage Context Based Restrictions in IBM Cloud.
> More information: <https://cloud.ibm.com/docs/account?topic=account-cbr-plugin>.

- 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}}`
28 changes: 28 additions & 0 deletions pages/common/ibmcloud-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# ibmcloud config

> Modify or read out values in the IBM Cloud CLI configuration.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_config>.

- 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`
16 changes: 16 additions & 0 deletions pages/common/ibmcloud-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# ibmcloud help

> Display help information for IBM Cloud CLI commands.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_help>.

- 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}}`
8 changes: 8 additions & 0 deletions pages/common/ibmcloud-logout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ibmcloud logout

> Log out of the IBM Cloud CLI.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_logout>.

- Log out of the current session:

`ibmcloud logout`
28 changes: 28 additions & 0 deletions pages/common/ibmcloud-plugin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# ibmcloud plugin

> Manage plugins and plugin repositories for the IBM Cloud CLI.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-plug-ins>.

- 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}}`
8 changes: 8 additions & 0 deletions pages/common/ibmcloud-regions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ibmcloud regions

> List all available regions on IBM Cloud.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_regions>.

- View information for all regions:

`ibmcloud regions`
28 changes: 28 additions & 0 deletions pages/common/ibmcloud-target.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# ibmcloud target

> Set or view the target account, region, or resource group.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_target>.

- 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`
12 changes: 12 additions & 0 deletions pages/common/ibmcloud-update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ibmcloud update

> Update the IBM Cloud CLI to the most recent version.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_update>.

- Update the CLI:

`ibmcloud update`

- Force an update without confirmation:

`ibmcloud update -f`
8 changes: 8 additions & 0 deletions pages/common/ibmcloud-version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ibmcloud version

> Print the version of the IBM Cloud CLI.
> More information: <https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cli#ibmcloud_version>.

- Display the CLI version:

`ibmcloud version`