---
name: hpc-spectrum-symphony-setting-up-cli
title: Setting up the IBM Cloud Schematics CLI
description: ''
last-updated: 2024-04-04
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/hpc-spectrum-symphony?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.

{:shortdesc: .shortdesc}
{:codeblock: .codeblock}
{:screen: .screen}
{:external: target="_blank" .external}
{:pre: .pre}
{:tip: .tip}
{:note: .note}
{:important: .important}
{:table: .aria-labeledby="caption"}

# Setting up the IBM Cloud Schematics CLI
{: #setting-up-cli}

Before you begin using the IBM Cloud® Schematics CLI to deploy IBM Spectrum Symphony, review and complete the following prerequisites:

1. Install the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli&format=markdown).
2. Log in to the IBM Cloud CLI with your IBMid. If you have multiple accounts, you are prompted to select which account to use. If you do not specify a region with the `-r` flag, you must also select a region.

    ```sh
    ibmcloud login
    ```
    {: pre}

    If your credentials are rejected, you might be using a federated ID. To log in with a federated ID, use the `--sso` flag. For more information, see [Logging in with a federated ID](https://cloud.ibm.com/docs/account?topic=account-federated_id&format=markdown).
    {: tip}

3. Install and set up the [IBM Cloud Schematics CLI plug-in](https://cloud.ibm.com/docs/schematics?topic=schematics-setup-cli&format=markdown#install-schematics-plugin).
4. Make sure to generate your IBM Cloud API key. For more information, see [Managing user API keys](https://cloud.ibm.com/docs/account?topic=account-userapikey&format=markdown).
5. Create the `config.json` file that represents the configuration parameters that you would like to use to build the IBM Spectrum Symphony cluster. To learn more about all the properties, see [Deployment values](https://cloud.ibm.com/docs/hpc-spectrum-symphony?topic=hpc-spectrum-symphony-deployment-values&format=markdown). You can view a sample configuration file [here](https://github.com/IBM-Cloud/hpc-cluster-symphony/blob/master/sample/configs/hpc_workspace_config.json){: external}. For more information about the sample JSON file used by the Schematics CLI, see [IBM Cloud Schematics CLI](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference&format=markdown){: external}. If you need to override any default parameters, you can redefine them in `variablestore`.
6. Update the mandatory properties for `api_key`, `ssh_key_name`, and `symphony_license_confirmation` based on your specific setup. 
7. Review and update any optional properties in the `config.json` file to fit your specific IBM Spectrum Symphony cluster instance. 

## Next steps
{: #next-steps-cli}

After you've reviewed and completed the prerequisites for setting up the CLI, you are ready to [Create a workspace](https://cloud.ibm.com/docs/hpc-spectrum-symphony?topic=hpc-spectrum-symphony-creating-workspace&interface=ui&format=markdown#before-you-begin-creating-cli).