PHPackages commerceguys/platform-cli - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [CLI & Console](/categories/cli) 4. / 5. commerceguys/platform-cli Abandoned → [platformsh/cli](/?search=platformsh%2Fcli)ArchivedLibrary[CLI & Console](/categories/cli) commerceguys/platform-cli ========================= Platform.sh CLI v3.76.0(4y ago)223179128[117 issues](https://github.com/platformsh/platformsh-cli/issues)[34 PRs](https://github.com/platformsh/platformsh-cli/pulls)MITPHPPHP >=5.5.9CI passing Since May 20Pushed 3mo ago23 watchersCompare [ Source](https://github.com/platformsh/platformsh-cli)[ Packagist](https://packagist.org/packages/commerceguys/platform-cli)[ RSS](/packages/commerceguys-platform-cli/feed)WikiDiscussions main Synced 3d ago READMEChangelog (10)Dependencies (20)Versions (398)Used By (0) The **Legacy** CLI is the legacy version of the command-line interface for [Upsun (formerly Platform.sh)](https://upsun.com). For the **current Upsun CLI**, check [this repository](https://github.com/platformsh/cli). Install ------- [](#install) To install the CLI, use either [Homebrew](https://brew.sh/) (on Linux, macOS, or the Windows Subsystem for Linux) or [Scoop](https://scoop.sh/) (on Windows): ### HomeBrew [](#homebrew) ``` brew install platformsh/tap/platformsh-cli ``` ### Scoop [](#scoop) ``` scoop bucket add platformsh https://github.com/platformsh/homebrew-tap.git scoop install platform ``` ### Manual installation [](#manual-installation) For manual installation, you can also [download the latest binaries](https://github.com/platformsh/cli/releases/latest). ### Legacy installer [](#legacy-installer) *This installation method is considered legacy and is discouraged, use one of the methods above instead. Starting with version 5.x, this installation method will not be supported.* In order to use the Legacy installer, you need to have an operating system supported by PHP (Linux, OS X, or Windows) and PHP 5.5.9 or higher, with the following extensions: `curl`, `json`, `pcre`, and `phar`. Run this command to install the CLI using the legacy installer, given that you have PHP already installed: ``` curl -sS https://platform.sh/cli/installer | php ``` In some Windows terminals you may need `php.exe` instead of `php`. Upgrade ------- [](#upgrade) Upgrade using the same tool: ### HomeBrew [](#homebrew-1) ``` brew upgrade platformsh-cli ``` ### Scoop [](#scoop-1) ``` scoop update platform ``` Usage ----- [](#usage) You can run this CLI in your shell by typing `platform`. ``` platform ``` Use the 'list' command to get a list of available options and commands: ``` platform list ``` Authentication -------------- [](#authentication) There are two ways to authenticate: 1. The recommended way is `platform login`, which lets you log in via a web browser, including via third-party providers such as Google, GitHub, GitLab and Bitbucket. 2. If using a browser is not possible, use an [API token](https://docs.upsun.com/anchors/fixed/cli/api-token/). An interactive command is available for this: `platform auth:api-token-login` For non-interactive uses such as scripts or CI systems, set the API token in an environment variable named `PLATFORMSH_CLI_TOKEN`. This can be insecure if not handled properly, although it is appropriate for systems such as CircleCI, Jenkins and GitLab. **Warning**: An API token can act as the account that created it, with no restrictions. Use a separate machine account to limit the token's access. Customization ------------- [](#customization) You can configure the CLI via the user configuration file `~/.platformsh/config.yaml`. The possible keys that can be overridden are in the [config-defaults.yaml](/config-defaults.yaml) and [config.yaml](/config.yaml) files. Other customization is available via environment variables, including: - `PLATFORMSH_CLI_DEBUG`: set to 1 to enable debugging. *Warning*: this could print HTTP request information in the terminal, including sensitive access tokens. - `PLATFORMSH_CLI_DEFAULT_TIMEOUT`: the timeout (in seconds) for most individual API requests. The default is 30. - `PLATFORMSH_CLI_DISABLE_CACHE`: set to 1 to disable caching - `PLATFORMSH_CLI_HOME`: override the home directory (inside which the .platformsh directory is stored) - `PLATFORMSH_CLI_NO_COLOR`: set to 1 to disable colors in output - `PLATFORMSH_CLI_NO_INTERACTION`: set to 1 to disable interaction (useful for scripting). Equivalent to the `--no-interaction` command-line option. *Warning*: this will bypass any confirmation questions. - `PLATFORMSH_CLI_SESSION_ID`: change user session (default 'default'). The `session:switch` command (beta) is now available as an alternative. - `PLATFORMSH_CLI_SHELL_CONFIG_FILE`: specify the shell configuration file that the installer should write to (as an absolute path). If not set, a file such as `~/.bashrc` will be chosen automatically. Set this to an empty string to disable writing to a shell config file. - `PLATFORMSH_CLI_TOKEN`: an API token. **Warning**: An API token can act as the account that created it, with no restrictions. Use a separate machine account to limit the token's access. Additionally, storing a secret in an environment variable can be insecure. It may be better to use the `auth:api-token-login` command. The environment variable is preferable on CI systems like Jenkins and GitLab. - `PLATFORMSH_CLI_UPDATES_CHECK`: set to 0 to disable the automatic updates check - `PLATFORMSH_CLI_SSH_AUTO_LOAD_CERT`: set to 0 to disable automatic loading of an SSH certificate when running login or SSH commands - `PLATFORMSH_CLI_REPORT_DEPRECATIONS`: set to 1 to enable PHP deprecation notices (suppressed by default). They will only be displayed in debug mode (`-vvv`). - `CLICOLOR_FORCE`: set to 1 or 0 to force colorized output on or off, respectively - `http_proxy` or `https_proxy`: specify an HTTP proxy Known issues ------------ [](#known-issues) ### Caching [](#caching) The CLI caches details of your projects and their environments, and some other information. These caches could become out-of-date. You can clear caches with the command `platform clear-cache` (or `platform cc` for short). Contributing ------------ [](#contributing) See [CONTRIBUTING.md](CONTRIBUTING.md) for how to contribute to the CLI. ### Health Score 49 — FairBetter than 95% of packages Maintenance44 Moderate activity, may be stable Popularity32 Limited adoption so far Community32 Small or concentrated contributor base Maturity78 Established project with proven stability Bus Factor1 Top contributor holds 91.9% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~7 days Recently: every ~2 days Total 383 Last Release 1565d ago Major Versions 1.1.1 → v3.4.02016-08-24 1.2.0 → v3.7.02016-10-27 1.3.0 → v3.8.12016-11-22 v3.47.0 → 4.x-dev2019-08-27 v0.0.26 → v3.60.22020-08-04 PHP version history (2 changes)v3.3.6PHP >=5.5.9 4.x-devPHP >=7.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/621c34dbc1ad3ea00e09f6006aa9607d0046bf862182d59c66f1f18cb51c0f15?d=identicon)[bojanz](/maintainers/bojanz) --- Top Contributors [![pjcdawkins](https://avatars.githubusercontent.com/u/1465106?v=4)](https://github.com/pjcdawkins "pjcdawkins (4347 commits)")[![bojanz](https://avatars.githubusercontent.com/u/330162?v=4)](https://github.com/bojanz "bojanz (109 commits)")[![Kazanir](https://avatars.githubusercontent.com/u/4731136?v=4)](https://github.com/Kazanir "Kazanir (80 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (58 commits)")[![kotnik](https://avatars.githubusercontent.com/u/187705?v=4)](https://github.com/kotnik "kotnik (24 commits)")[![matthiaz](https://avatars.githubusercontent.com/u/3532563?v=4)](https://github.com/matthiaz "matthiaz (17 commits)")[![vitolkachova](https://avatars.githubusercontent.com/u/208131540?v=4)](https://github.com/vitolkachova "vitolkachova (11 commits)")[![OriPekelman](https://avatars.githubusercontent.com/u/138636?v=4)](https://github.com/OriPekelman "OriPekelman (10 commits)")[![Crell](https://avatars.githubusercontent.com/u/254863?v=4)](https://github.com/Crell "Crell (8 commits)")[![ricardokirkner](https://avatars.githubusercontent.com/u/478971?v=4)](https://github.com/ricardokirkner "ricardokirkner (7 commits)")[![romainneutron](https://avatars.githubusercontent.com/u/137574?v=4)](https://github.com/romainneutron "romainneutron (6 commits)")[![dwkitchen](https://avatars.githubusercontent.com/u/1096557?v=4)](https://github.com/dwkitchen "dwkitchen (6 commits)")[![hanoii](https://avatars.githubusercontent.com/u/677879?v=4)](https://github.com/hanoii "hanoii (5 commits)")[![ralt](https://avatars.githubusercontent.com/u/1016379?v=4)](https://github.com/ralt "ralt (5 commits)")[![cs278](https://avatars.githubusercontent.com/u/17377?v=4)](https://github.com/cs278 "cs278 (4 commits)")[![damz](https://avatars.githubusercontent.com/u/110678?v=4)](https://github.com/damz "damz (4 commits)")[![hayleemillar](https://avatars.githubusercontent.com/u/32496943?v=4)](https://github.com/hayleemillar "hayleemillar (3 commits)")[![fabpot](https://avatars.githubusercontent.com/u/47313?v=4)](https://github.com/fabpot "fabpot (3 commits)")[![nvahalik](https://avatars.githubusercontent.com/u/632120?v=4)](https://github.com/nvahalik "nvahalik (3 commits)")[![shahinam](https://avatars.githubusercontent.com/u/264215?v=4)](https://github.com/shahinam "shahinam (3 commits)") --- Tags clicloudcommand-line-toolpaasphpplatformsymfony-console ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/commerceguys-platform-cli/health.svg) ``` [![Health](https://phpackages.com/badges/commerceguys-platform-cli/health.svg)](https://phpackages.com/packages/commerceguys-platform-cli) ``` ### Alternatives [sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube)[shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[platformsh/cli Platform.sh CLI 23238.0k](/packages/platformsh-cli)[drupal/core Drupal is an open source content management platform powering millions of websites and applications. 19462.3M1.3k](/packages/drupal-core) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)