---
name: logs-router-logs-router-cli-config
title: Configuring the CLI to manage IBM Cloud Logs Routing account configuration
description: You must configure your local IBM Cloud Logs Routing CLI so that you can manage the IBM Cloud Logs Routing account configuration by using CLI commands.
last-updated: 2026-04-28
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/logs-router?format=markdown
> The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt
> Use these files to discover more information as needed.

# Configuring the CLI to manage IBM Cloud Logs Routing account configuration
{: #logs-router-cli-config}

You must configure your local IBM Cloud Logs Routing CLI so that you can manage the IBM Cloud Logs Routing account configuration by using CLI commands.
{: shortdesc}

## Step 1: Installing the CLI locally
{: #logs-router-cli-config-install}


Complete the following steps to install the IBM Cloud Logs Routing CLI:

1. [Install the IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli&format=markdown).

2. Get the versions that are available for the `logs-router` CLI plug-in. Run the following command:

    ```sh
    ibmcloud plugin repo-plugins
    ```
    {: pre}

    For example, to get the versions of the IBM Cloud Logs Routing CLI plug-in, run the following command:

    ```sh
    ibmcloud plugin repo-plugins | grep logs-router
    ```
    {: pre}

    The output of the command lists the versions that are available.

3. Install the CLI plugin in your local system. Run the following command:

    ```sh
    ibmcloud plugin install logs-router [-v VERSION]
    ```
    {: pre}

    Where `VERSION` is the value of a listed version that is available for the plug-in.


If you have the IBM Cloud Logs Routing CLI plug-in in your local system and you want to update the version of the plug-in, run the following command: `ibmcloud plugin update logs-router`.
{: tip}

If you want to delete the IBM Cloud Logs Routing CLI plug-in from your local system, run the following command: `ibmcloud plugin delete logs-router`.
{: tip}


## Step 2: Configuring the primary metadata region
{: #logs-router-cli-config-metadata}


Before you can use the IBM Cloud Logs Routing CLI to manage routes or targets, you must configure a primary metadata region.
{: attention}

You can configure the primary metadata region by using the following command:

```sh
ibmcloud logs-router setting update command --primary-metadata-region PRIMARY-METADATA-REGION
```
{: codeblock}

Where `PRIMARY-METADATA-REGION` is set to a supported location. For more information, see [Locations](https://cloud.ibm.com/docs/logs-router?topic=logs-router-locations&format=markdown).

## Updating the CLI
{: #logs-router-cli-config-update}

To update the CLI, run the following command:

```sh
ibmcloud plugin update logs-router
```
{: pre}

## Deleting the CLI
{: #logs-router-cli-config-delete}


To delete the CLI, run the following command:

```sh
ibmcloud plugin delete logs-router
```
{: pre}