Get Started with the Command-Line Interface for SAP Cloud Platform (sapcp CLI)

The sapcp CLI is an alternative to the cockpit, for users who prefer working on the command line. It consists of a client and a server. The client needs to be installed on your computer (make sure you update it regularly!) and it interacts with SAP Cloud Platform through a server. You connect to this CLI server at login.

The base call to enter on the command line is sapcp.

Here are some of the tasks you can use the CLI for:

• Creating subaccounts
• Managing entitlements of global accounts and subaccounts
• Managing users and their authorizations in global accounts and subaccounts
• Subscribing to applications

SAP is currently migrating all SAP Cloud Platform global accounts from the existing cloud management tools feature set A to the renovated cloud management tools feature set B. One of the innovations of feature set B is the new Command Line Interface (sapcp CLI) for account management. With your CF trial account, you can already try out the sapcp CLI.

Here you can read more about the Cloud Management Tools Feature Set B Innovations.

You may have worked with the Cloud Foundry CLI (cf CLI) to manage your Cloud Foundry environment. Let’s quickly explain how the cf CLI relates to the sapcp CLI:
The sapcp CLI is the CLI for working with SAP Cloud Platform accounts. You use the sapcp CLI for all tasks on global account, directory, and subaccount level. Going down the account hierarchy, the last step with sapcp CLI is creating a Cloud Foundry environment instance, which essentially creates a Cloud Foundry org. From org level onwards, i.e. for managing members in orgs and spaces, creating spaces, assigning quota to orgs and spaces, you use the cf CLI.

Go to the SAP Development Tools page to download the latest version of the CLI client for your operating system. Unpack the archive and copy the client file (for example, sapcp.exe) to your local system. Make sure you have read and write permissions in the target folder to run the executable.

In Windows, open the directory where the the client file is located in the command line and and enter ‘sapcp’. For example, you can open the folder and type cmd into the address bar.

If you are using macOS, make sure that the client file is in your PATH and open a terminal session. Note that sapcp CLI may be blocked because it is “from an unidentified developer”. Please refer to the macOS documentation to learn how to bypass this.

You get version information, the usage, and you learn where the configuration file is located. Also, you get useful tips how to login and get help in the client.

Each command starts off with the base call sapcp. The syntax of the command itself is very close to natural language: It starts with a verb, i.e. the action, followed by a group/object combination. So you build a command by combining sapcp with an action (let’s say list) and a group/object combination (let’s say accounts/subaccount): sapcp list accounts/subaccount

For the time being, the object is always a singular noun. Even for list commands, where you might naturally want to use a plural form.

Here are a few simple examples of commands on global account level that you can try out:

Or go through the documentation to learn more:

• Account Administration Using the CLI for SAP Cloud Platform
• Commands in the sapcp CLI