README

**Legacy** Platform.sh CLI是Platform.sh的旧版命令行界面。对于**当前Platform.sh CLI**，请查看此仓库。

安装

要安装CLI，可以使用Homebrew（在Linux、macOS或Windows子系统Linux上）或Scoop（在Windows上）。

HomeBrew

brew install platformsh/tap/platformsh-cli

Scoop

scoop bucket add platformsh https://github.com/platformsh/homebrew-tap.git
scoop install platform

手动安装

对于手动安装，您还可以下载最新版本的可执行文件。

旧版安装程序

此安装方法被认为是过时的，并建议使用上述方法之一。从5.x版本开始，此安装方法将不再受支持。

为了使用旧版安装程序，您需要有一个由PHP支持的操作系统（Linux、OS X或Windows）和PHP 5.5.9或更高版本，以下扩展：curl、json、pcre和phar。

在已安装PHP的情况下，运行此命令以使用旧版安装程序安装CLI

curl -sS https://platform.sh/cli/installer | php

在某些Windows终端中，您可能需要使用php.exe而不是php。

升级

使用相同的工具进行升级

HomeBrew

brew upgrade platformsh-cli

Scoop

scoop update platform

用法

您可以在shell中通过输入platform来运行Platform.sh CLI。

platform

使用'list'命令获取可用选项和命令的列表

platform list

认证

有两种认证方式

1. 推荐的方式是platform login，它允许您通过网页浏览器登录，包括通过Google、GitHub、GitLab和Bitbucket等第三方提供者。

2. 如果无法使用浏览器，请使用API令牌。

   为此提供了一个交互式命令：platform auth:api-token-login

   对于非交互式用途，如脚本或CI系统，请将API令牌设置在名为PLATFORMSH_CLI_TOKEN的环境变量中。如果不妥善处理，这可能会不安全，尽管它适用于CircleCI、Jenkins和GitLab等系统。

   警告：API令牌可以充当创建它的账户，没有任何限制。请使用单独的机器账户来限制令牌的访问权限。

自定义

您可以通过用户配置文件~/.platformsh/config.yaml来配置CLI。

可以覆盖的可能键在config-defaults.yaml和config.yaml文件中。

其他自定义可通过环境变量进行，包括

• PLATFORMSH_CLI_DEBUG：设置为1以启用调试。警告：这可能会在终端中打印HTTP请求信息，包括敏感访问令牌。
• PLATFORMSH_CLI_DEFAULT_TIMEOUT：大多数单个API请求的超时时间（以秒为单位）。默认值为30。
• PLATFORMSH_CLI_DISABLE_CACHE：设置为1以禁用缓存
• PLATFORMSH_CLI_HOME：覆盖主目录（其中包含.platformsh目录）
• PLATFORMSH_CLI_NO_COLOR：设置为1以禁用输出中的颜色
• PLATFORMSH_CLI_NO_INTERACTION：设置为1以禁用交互（对于脚本很有用）。等同于命令行选项--no-interaction。警告：这将绕过任何确认问题。
• PLATFORMSH_CLI_SESSION_ID：更改用户会话（默认为'default'）。现在可用session:switch命令（beta）作为替代。
• PLATFORMSH_CLI_SHELL_CONFIG_FILE：指定安装程序应写入的shell配置文件（绝对路径）。如果没有设置，将自动选择如~/.bashrc之类的文件。将其设置为空字符串以禁用写入shell配置文件。
• PLATFORMSH_CLI_TOKEN：API令牌。警告：API令牌可以充当创建它的账户，没有任何限制。使用单独的机器账户可以限制令牌的访问。此外，在环境变量中存储机密可能不安全。最好使用auth:api-token-login命令。在Jenkins和GitLab等CI系统上，环境变量更受青睐。
• PLATFORMSH_CLI_UPDATES_CHECK：设置为0以禁用自动更新检查
• PLATFORMSH_CLI_SSH_AUTO_LOAD_CERT：设置为0以禁用在运行登录或SSH命令时自动加载SSH证书
• PLATFORMSH_CLI_REPORT_DEPRECATIONS：设置为1以启用PHP弃用通知（默认情况下被抑制）。它们仅在调试模式下显示（-vvv）。
• CLICOLOR_FORCE：设置为1或0以分别强制开启或关闭彩色输出
• http_proxy或https_proxy：指定连接到Platform.sh的代理

已知问题

缓存

CLI缓存了您的项目及其环境的详细信息，以及一些其他信息。这些缓存可能已过时。您可以使用命令platform clear-cache（或简写为platform cc）来清除缓存。

贡献

有关如何为CLI贡献的说明，请参阅CONTRIBUTING.md。