这些说明解释了如何使用 Space and Time 命令行界面向 Space and Time 注册和验证。

Space and Time CLI (sxtcli) 是一个命令行工具，用于从客户端计算机（例如笔记本电脑或应用程序服务器）与 Space and Time 网络进行交互。它使用 Java 来提供跨平台支持，可以在 Windows、MacOS 或 Linux 上运行。

文档中的几乎所有示例都将使用 CLI 作为主要工具。CLI 是开发人员连接 Space and Time 的最简单方法，但并不是唯一的方法。请查看此页面，了解连接方式以了解更多信息。

1. API 基本 URL - 如果您不知道 SxT API URL，可以在此处查找。

2. JoinCode（可选） - 如果您想要加入现有的 Space and Time 订阅，则需要您组织的 JoinCode。您将在欢迎使用 Space and Time 电子邮件中收到您的加入代码。

   如何通过 CLI 连接到空间和时间网络

   第 1 步：下载并安装最新的JavaJDK

   Java 在大多数开发机器上都是相当标准的安装。要测试是否安装了 Java，请打开终端/CMD 并输入， 它应该返回类似以下内容：java --version

   shell

   └─[$] java --version
   
   java 20.0.1 2023-04-18
   Java(TM) SE Runtime Environment (build 20.0.1+9-29)
   Java HotSpot(TM) 64-Bit Server VM (build 20.0.1+9-29, mixed mode, sharing)
   

   第 2 步：下载并运行SxTCLI jar

   此 SxTCLI 链接将带您进入包含所有 CLI 版本的顶级目录。我们强烈建议您始终安装最新版本。在版本文件夹中，您将看到两个文件：.jar 和 .pom。对于大多数用途，您只需下载 .jar 文件，而不是 .pom 文件。将下载的文件保存到您选择的位置。

   要进行测试，请打开终端/CMD，导航到保存 .jar 的文件夹，然后输入：java -jar sxtcli-<version>.jar help

   您应该看到返回的菜单，类似于：

   Shell

   └─[$] java -jar sxtcli-<version>.jar help   
                                       
   Usage: <main class> [COMMAND]
   Commands:
     help          Display help information about the specified command.
     authenticate  Perform platform authentication commands.
     biscuit       Perform biscuit commands.
     discover      Perform resource discovery commands.
     sql           Perform SQL commands.
     sql-support   Perform supporting SQL commands.
   

   步骤 3：将 CLI 添加到您的 shell 环境（可选）

   为了便于使用，建议创建用于运行 SxT CLI 的 shell 别名。向 shell 添加别名取决于您的操作系统。

   Mac OS X 和 Linux

   使用您选择的编辑器编辑您的 shell 配置文件：

   Mac OSX-~/.zshrc

   Linux-~/.bash_profile

   Add this line:

   Shell

   alias sxtcli='java -jar <PathToJar>/sxtcli-<LATEST_VERSION>.jar'
   

   可选：可以在同一配置文件脚本中进一步引用上面定义的别名。例如，如果您将用户机密保存到通用.env 文件中，则可以在 shell 配置文件的末尾添加另一行，从而允许您使用一个命令登录 Space and Time： sxtlogin

   Shell

   sxtlogin() {
       . ~/Path/to/my/.env
       ACCESS_TOKEN=$(sxtcli authenticate login --url=$API_URL --userId=$USERID --publicKey=$USER_PUBLIC_KEY --privateKey=$USER_PRIVATE_KEY | awk 'NR==2{ print $2 }' )
       echo $ACCESS_TOKEN
   }
   

   🚧

   您必须重新加载 shell 或打开新终端才能正确加载新别名。另外，如果您使用的是 OSX 并且想要升级您的 shell 游戏，请查看OhMyZsh。

   视窗

   有关将 CLI 添加到Windows 上的环境变量的说明，请参阅此资源。PATH

   测试 CLI 执行

   要测试安装是否成功，请从任何文件夹位置打开终端/CMD，然后运行命令 如果正确完成，您现在可以从任何地方运行。sxtcli help

   sxtcli

   步骤 4：设置 dotenv 文件（可选）

   虽然在技术上是可选的，但我们建议您设置一个环境变量文件（有时称为 dotenv 或“.env”文件）来保存本地机密，例如您的 UserID 和 KeyPair。这是一般开发最佳实践，并非特定于 SxT，但是，您会看到 SxT 文档、SDK 等中经常使用 dotenv 文件。

   请参阅有关使用Dotenv 文件获取机密的SxT 最佳实践指南。

   对于下面的示例（以及本文档中的几乎所有其他示例），我们假设环境变量与此处看到的相匹配。

   第5步：注册并验证

   如果您是 SxT 新手并注册新用户 ID，可以使用以下命令：

   shell

   sxtcli authenticate register --url=$API_URL --userId=$USERID --code="<joinCode>"
   

   请记下公钥和私钥，并将您的私钥存储在安全的地方，例如密码管理器。一旦您的终端窗口关闭，任何信息都无法恢复。丢失密钥对就等于失去对用户 ID 的控制！

   如果您已经拥有 SxT 用户 ID，则可以通过在终端窗口中键入以下内容轻松地向空间和时间网络进行身份验证：

   Shell

   sxtcli authenticate login --url=$API_URL --userId=$USERID --publicKey=$USER_PUBLIC_KEY --privateKey=$USER_PRIVATE_KEY
   

   就是这样！

   您已使用 CLI 成功注册并直接向 Space and Time 网络进行身份验证。

   使用 CLI 还可以使用许多其他选项，包括登录、刷新会话、针对 SxT 网络运行查询、向钥匙串添加新密钥对、管理订阅、查找过去的查询活动等。选项列表，只需运行 sxtcli help

这些说明解释了如何使用 Space and Time 命令行界面向 Space and Time 注册和验证。

Space and Time CLI (sxtcli) 是一个命令行工具，用于从客户端计算机（例如笔记本电脑或应用程序服务器）与 Space and Time 网络进行交互。它使用 Java 来提供跨平台支持，可以在 Windows、MacOS 或 Linux 上运行。

文档中的几乎所有示例都将使用 CLI 作为主要工具。CLI 是开发人员连接 Space and Time 的最简单方法，但并不是唯一的方法。请查看此页面，了解连接方式以了解更多信息。

1. API 基本 URL - 如果您不知道 SxT API URL，可以在此处查找。

2. JoinCode（可选） - 如果您想要加入现有的 Space and Time 订阅，则需要您组织的 JoinCode。您将在欢迎使用 Space and Time 电子邮件中收到您的加入代码。

   如何通过 CLI 连接到空间和时间网络

   第 1 步：下载并安装最新的JavaJDK

   Java 在大多数开发机器上都是相当标准的安装。要测试是否安装了 Java，请打开终端/CMD 并输入， 它应该返回类似以下内容：java --version

   shell

   └─[$] java --version
   
   java 20.0.1 2023-04-18
   Java(TM) SE Runtime Environment (build 20.0.1+9-29)
   Java HotSpot(TM) 64-Bit Server VM (build 20.0.1+9-29, mixed mode, sharing)
   

   第 2 步：下载并运行SxTCLI jar

   此 SxTCLI 链接将带您进入包含所有 CLI 版本的顶级目录。我们强烈建议您始终安装最新版本。在版本文件夹中，您将看到两个文件：.jar 和 .pom。对于大多数用途，您只需下载 .jar 文件，而不是 .pom 文件。将下载的文件保存到您选择的位置。

   要进行测试，请打开终端/CMD，导航到保存 .jar 的文件夹，然后输入：java -jar sxtcli-<version>.jar help

   您应该看到返回的菜单，类似于：

   Shell

   └─[$] java -jar sxtcli-<version>.jar help   
                                       
   Usage: <main class> [COMMAND]
   Commands:
     help          Display help information about the specified command.
     authenticate  Perform platform authentication commands.
     biscuit       Perform biscuit commands.
     discover      Perform resource discovery commands.
     sql           Perform SQL commands.
     sql-support   Perform supporting SQL commands.
   

   步骤 3：将 CLI 添加到您的 shell 环境（可选）

   为了便于使用，建议创建用于运行 SxT CLI 的 shell 别名。向 shell 添加别名取决于您的操作系统。

   Mac OS X 和 Linux

   使用您选择的编辑器编辑您的 shell 配置文件：

   Mac OSX-~/.zshrc

   Linux-~/.bash_profile

   Add this line:

   Shell

   alias sxtcli='java -jar <PathToJar>/sxtcli-<LATEST_VERSION>.jar'
   

   可选：可以在同一配置文件脚本中进一步引用上面定义的别名。例如，如果您将用户机密保存到通用.env 文件中，则可以在 shell 配置文件的末尾添加另一行，从而允许您使用一个命令登录 Space and Time： sxtlogin

   Shell

   sxtlogin() {
       . ~/Path/to/my/.env
       ACCESS_TOKEN=$(sxtcli authenticate login --url=$API_URL --userId=$USERID --publicKey=$USER_PUBLIC_KEY --privateKey=$USER_PRIVATE_KEY | awk 'NR==2{ print $2 }' )
       echo $ACCESS_TOKEN
   }
   

   🚧

   您必须重新加载 shell 或打开新终端才能正确加载新别名。另外，如果您使用的是 OSX 并且想要升级您的 shell 游戏，请查看OhMyZsh。

   视窗

   有关将 CLI 添加到Windows 上的环境变量的说明，请参阅此资源。PATH

   测试 CLI 执行

   要测试安装是否成功，请从任何文件夹位置打开终端/CMD，然后运行命令 如果正确完成，您现在可以从任何地方运行。sxtcli help

   sxtcli

   步骤 4：设置 dotenv 文件（可选）

   虽然在技术上是可选的，但我们建议您设置一个环境变量文件（有时称为 dotenv 或“.env”文件）来保存本地机密，例如您的 UserID 和 KeyPair。这是一般开发最佳实践，并非特定于 SxT，但是，您会看到 SxT 文档、SDK 等中经常使用 dotenv 文件。

   请参阅有关使用Dotenv 文件获取机密的SxT 最佳实践指南。

   对于下面的示例（以及本文档中的几乎所有其他示例），我们假设环境变量与此处看到的相匹配。

   第5步：注册并验证

   如果您是 SxT 新手并注册新用户 ID，可以使用以下命令：

   shell

   sxtcli authenticate register --url=$API_URL --userId=$USERID --code="<joinCode>"
   

   请记下公钥和私钥，并将您的私钥存储在安全的地方，例如密码管理器。一旦您的终端窗口关闭，任何信息都无法恢复。丢失密钥对就等于失去对用户 ID 的控制！

   如果您已经拥有 SxT 用户 ID，则可以通过在终端窗口中键入以下内容轻松地向空间和时间网络进行身份验证：

   Shell

   sxtcli authenticate login --url=$API_URL --userId=$USERID --publicKey=$USER_PUBLIC_KEY --privateKey=$USER_PRIVATE_KEY
   

   就是这样！

   您已使用 CLI 成功注册并直接向 Space and Time 网络进行身份验证。

   使用 CLI 还可以使用许多其他选项，包括登录、刷新会话、针对 SxT 网络运行查询、向钥匙串添加新密钥对、管理订阅、查找过去的查询活动等。选项列表，只需运行 sxtcli help