README

CLI 客户端和 PHP 库，用于访问 NorthStack NorthStack API

安装

要求

安装和运行 NorthStack CLI 有两种方法。主要方式是本地安装（需要您已安装 PHP 7.2）和基于 docker 的包装器，后者不需要。两种安装方法都需要您安装 docker。

本地安装方式是首选且性能更好，因此如果您能为您操作系统安装 PHP >= 7.2，则最好这样做。如果您运行的是现代 Linux 发行版，则可能只需执行 $packageManager install php72。如果您使用的是 macOS，则最简单的方法是使用 homebrew。

安装

git clone https://github.com/northstack/northstack-client.git
cd northstack-client
./bin/install.sh

某些安装设置可以通过 CLI 参数进行配置

  -a <path>          Set the app directory       (default = $HOME/northstack/apps)
  -p <path>          Set the install prefix      (default = $HOME/.local)
  -m docker|native   Set the install method      (default = auto)
  -d                 Install in dev mode         (default = false)
  -n                 Don't prompt for any input  (default = no)

安装后

CLI 安装到 $INSTALL_PREFIX/bin（默认 ~/.local/bin），这可能在或可能不在您的 $PATH 中。如果这样，安装程序会尝试为您更新 rc 文件

[2019-06-26 14:50:00] [warn] /home/ns/.local/bin is not in your $PATH
Would you like us to update your .bashrc/.zshrc files?
Enter yes/no (default = no): yes
101a102,104
> # NorthStack START
> PATH=/home/ns/.local/bin:$PATH
> # NorthStack END
[2019-06-26 14:51:39] [info] Updating: /home/ns/.bashrc

确保在此之后执行 source ~/.bashrc！

CLI 还支持自动完成。启用此功能的过程因平台而异，但您也可以直接将完成钩子添加到您的 bashrc 中

$ ~/.local/bin/northstack _completion --generate-hook --program northstack >> ~/.bashrc

使用客户端

登录

northstack auth:login my@northstack-username.com

这将保存登录令牌到 ~/.northstacklogin。登录有效期为 14 小时。之后您需要再次登录。

此文件将自动由所有其他命令读取并用于授权访问 NorthStack API。

您还可以使用您的 API 密钥通过 auth:client-login 命令登录。

完成操作后，您可以使用 auth:logout 命令或简单地删除 ~/.northstacklogin 文件。

命令

单独执行 northstack 命令将显示可用的命令。

northstack

要获取任何命令的用法帮助，只需在命令名称前加上 help

northstack help auth:login

帮助！

我的账户 ID 是什么？

1. 您可以通过登录到 https://console.northstack.com 并查看浏览器中的地址来获取您的账户 ID。您的账户 ID 将在仪表板上标记为 Account ID。

2. 如果您是协作人员且需要其他账户的ID，请登录到控制台（上面的链接）并使用账户切换器（点击右上角的名字）切换到相关的组织。仪表板上的账户ID将更改为反映您当前查看的组织。