README

此实用程序允许通过命令行与ServerGrove控制面板进行交互。它还提供交互式外壳。

以下是一些命令行工具：

• API客户端命令行界面
• 交互式外壳

API客户端CLI允许通过HTTP API连接到ServerGrove控制面板。要连接到API，您需要成为具有访问控制面板和API权限的注册客户，并且需要在用户配置文件中启用API访问。

安装

您需要PHP 5.3

下载可执行文件sgcli.phar并将其放置在您的PATH目录中。

确保sgcli.phar具有可执行权限或使用php sgcli.phar

配置

默认情况下，API客户端将使用我们的演示API密钥/密钥组合。这仅允许您对服务器运行一些测试，但不会允许您访问您的帐户和服务器。

您需要在https://control.servergrove.com/profile中的用户配置文件中启用API访问

一旦您有了API密钥和密钥，将其添加到您的环境变量中

Example:
	$ export SG_API_KEY=yourkey
	$ export SG_API_SECRET=yoursecret

• 对于*nix，将这些两行添加到用户的~/.profile中

用法

./sgcli.phar client call [args]

• 调用：由命名空间和操作组成的调用（例如：server/list）
• 参数：（可选）要发送到调用的变量列表（例如：serverId=abc123&isActive=0）

示例

./sgcli.phar client test/version
./sgcli.phar client server/list
./sgcli.phar client server/stop serverId=abc123

交互式外壳

./sgcli.phar shell

命令

• help/h/? - 列出命令
• servers - 列出服务器
• server [选项] - 从服务器列表中选择服务器。选项可以是列表中的数字选项或服务器名称。也可以提供部分名称，它将选择第一个匹配项
• exec cmd - 在选定的服务器上执行命令
• reboot [服务器] - 重启服务器。[服务器]是可选的。如果没有给出，它将使用选定的服务器。在进行之前将要求确认
• shutdown [服务器] - 关闭服务器。[服务器]是可选的。如果没有给出，它将使用选定的服务器。在进行之前将要求确认
• bootup [服务器] - 启动服务器。[服务器]是可选的。如果没有给出，它将使用选定的服务器
• domains - 列出选定服务器下的域名
• domain [选项] - 从域名列表中选择域名。选项可以是列表中的数字选项或域名名称。也可以提供部分名称，它将选择第一个匹配项
• apps - 列出选定服务器下的应用程序
• app [选项] - 从应用程序列表中选择应用程序。选项可以是列表中的数字选项或应用程序名称。也可以提供部分名称，它将选择第一个匹配项
• restart [应用程序] - 重新启动应用程序。[应用程序]是可选的。如果没有给出，它将使用选定的应用程序。在进行之前将要求确认
• stop [应用程序] - 停止应用程序。[应用程序]是可选的。如果没有给出，它将使用选定的应用程序。在进行之前将要求确认
• start [应用程序] - 启动应用程序。[应用程序]是可选的。如果没有给出，它将使用选定的应用程序
• .- 再次运行最后一个命令
• x - 重置内部选择
• exit/quit - 退出外壳

警告

注意：API仍在积极开发中，因此某些内容可能会发生变化。请留意。

更多信息

• 可用API调用和参数列表
• ServerGrove网站
• ServerGrove 博客
• ServerGrove 控制面板
• ServerGrove 知识库
• 关注 ServerGrove 在 Twitter
• GitHub 下载

待办事项 & 贡献

我们希望添加很多功能。如果您有任何精彩的想法，请随时向我们发送建议或甚至 Pull Requests。这是一个 Github 项目，所以任何人都可以分支它并扩展它！

我们喜欢 PRs！

致谢

• Fabien Potencier 为出色的 Symfony 组件。
• Composer 团队为我们提供了关于应用程序代码和 phar 文件编译器的灵感。