northstack/northstack-client

无服务器环境管理命令

0.0.4 2019-06-27 14:47 UTC

README

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

Build status

安装

要求

安装和运行NorthStack CLI有两种方式。主要方式是本地安装(需要您安装PHP 7.2)和一个基于Docker的包装器,后者不需要。两种安装方法都需要您安装Docker。

本地安装方式是首选且性能更优,因此最好能够为您的操作系统安装PHP >= 7.2。如果您正在运行现代Linux发行版,则可能只需执行$packageManager install php72。如果您使用OSX,则最简单的方法是使用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还支持Tab补全。启用此功能的过程因平台而异,但您也可以直接将完成钩子添加到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,请登录到控制台(上面的链接)并使用账户切换器(点击右上角的名字)切换到您需要查看的组织。仪表板上的Account ID将更改为反映您正在查看的当前组织。