Platform CLI Overview

Platform CLI Overview

The platform command-line interface allows administrators and developers to manage their cloud account directly from a local terminal. It provides a practical way to automate frequent operations, monitor environments and integrate platform management into DevOps workflows.

The CLI exposes preconfigured commands that correspond to available platform API methods. Commands can be executed individually or combined into reusable scripts for environment lifecycle management, application deployment, monitoring and infrastructure operations.

Because the CLI follows the same hierarchy as the platform API, users can navigate through command folders and quickly locate the method required for a particular operation.

In this article

CLI Benefits

  • Manage cloud environments without opening the web dashboard.
  • Automate repetitive administration and deployment tasks.
  • Combine multiple commands into shell scripts and operational workflows.
  • Integrate environment management with CI/CD pipelines.
  • Monitor resources and execute lifecycle actions remotely.
  • Use platform API methods through simplified terminal commands.
✓

Recommended use

The CLI is especially useful for repeated operations, scheduled tasks, development automation and complex DevOps processes that would otherwise require multiple manual actions in the dashboard.

System Requirements

  • Java version 8 or later installed on the local machine.
  • A supported terminal or shell environment.
  • Internet access to the target cloud platform.
  • A valid platform account and login credentials.
  • For Windows, a Unix-compatible terminal environment such as Cygwin or an equivalent shell.
i

Note

On Windows, run the installation and CLI commands from a Unix-like terminal environment. Standard Command Prompt behaviour may differ from the expected shell environment.

CLI Installation

1

Open your terminal

Start a terminal session on the local machine where the CLI should be installed. Confirm that Java is available before running the installer.

Installation command
curl -s ftp://ftp.jelastic.com/pub/cli/jelastic-cli-installer.sh | bash
2

Run the installer

Execute the installation command. The script downloads the CLI package and creates a dedicated jelastic directory inside the current user’s home folder.

Platform CLI installation in terminal
CLI installation from a local terminal.

The installed folder contains an executable Java archive and a hierarchy of shell scripts. This folder structure reflects the platform API categories, making commands easier to discover and understand.

Environment Commands for environment lifecycle, scaling, migration, cloning and configuration.
Marketplace Commands for installing packages, add-ons and application manifests.
Account Commands related to authentication, users and account-level settings.
Administration Commands for supported platform administration and operational tasks.

Account Authentication

Authentication is normally requested automatically when the first CLI command is executed. The terminal prompts for the platform URL and account credentials.

1

Execute a CLI command

Run any available command from the installed CLI directory. When no active session exists, the authentication questionnaire starts automatically.

2

Enter the platform details

Provide the required information when prompted:

  • Platform URL: the cloud platform address, typically in an app.provider-domain format.
  • Email: the login email linked to the platform account.
  • Password: the account password.
CLI account authentication prompts
Authenticate the CLI with the target platform URL and account credentials.

After successful authentication, the terminal displays the platform identity and CLI version information. The session can then be used to execute account and environment operations.

✓

Session switching

Run the authentication command manually when you need to connect to a different account or another cloud platform installation.

Manual authentication
~/jelastic/users/authentication/signin

Command Help and Structure

The CLI includes an embedded help command that displays the available categories and methods. Use it when exploring the command hierarchy or identifying the correct operation.

Open CLI help
~/jelastic/help
CLI embedded help and method hierarchy
The help command displays available CLI categories and methods.

Each method is represented by a same-named script inside the corresponding category folder. This means a method path generally follows the pattern below:

Command structure
~/jelastic/{category}/{service}/{method} --parameter value

For example, environment lifecycle operations are typically located under the environment/control folder, while file-related commands are available under environment/file.

Method path Identifies the platform API category, service and operation.
Parameters Pass the environment name, node ID, region, resource values or other required inputs.
Response Returns the operation result and additional information in a structured response.
Result value A successful operation commonly returns a result value of 0.

Expected Result

After installation and authentication, the CLI can be used from the local terminal to manage platform environments and services. Administrators can execute individual methods, review structured responses and combine commands into scripts for automation.

Important Notes

  • Protect account credentials and avoid storing plain-text passwords inside shared scripts.
  • Test automation commands in a non-production environment before using them on live applications.
  • Confirm command parameters carefully before performing destructive or irreversible operations.
  • Use the embedded help and API documentation to verify required and optional parameters.
  • Review the returned result and error details after every automated operation.

What’s next?