Lib.rs

galoy-cli

galoy-cli 是一个用于与 Galoy 后端交互的命令行界面 (CLI) 客户端。它提供各种子命令以执行不同的操作，方便开发者和用户与 Galoy 后端交互。

安装

先决条件

在开始之前，请确保您已安装以下内容

• Rust（从源代码构建所需）
• Cargo（Rust 的包管理器）

Cargo

如果您已安装 Rust 和 Cargo，可以使用以下命令轻松安装 galoy-cli

cargo install galoy-cli

这将从 crates.io 仓库获取最新的 galoy-cli 版本，并在您的系统上全局安装。

版本

您可以从 版本页面 下载预构建的 galoy-cli 二进制文件。按照以下步骤操作

1. 访问 galoy-cli 仓库的版本页面。
2. 找到最新版本并导航到“资产”部分。
3. 根据您的操作系统，下载相应的二进制文件（例如，Linux 使用 galoy-cli-x86_64-unknown-linux-mus，macOS 使用 galoy-cli-x86_64-apple-darwin，Windows 使用 galoy-cli-x86_64-pc-windows）。
4. 下载完成后，使用以下命令使二进制文件可执行（如果需要）

chmod +x galoy-cli

5. 可选地，将二进制文件移动到系统 PATH 列表中的目录，以便在任何地方访问。

验证

要验证安装，请在新终端窗口中运行

galoy-cli --version

您应看到 galoy-cli 的版本号显示。

用法

Galoy CLI 提供了一系列命令，用于与 Galoy 后端交互。每个命令都服务于特定目的，并允许您无缝执行各种操作。以下是使用 galoy-cli 的简单指南。

galoy-cli [OPTIONS] <COMMAND>

以下是一些主要命令及其功能的简要说明：

request-phone-code

从手机号码请求验证码以启动用户认证。

galoy-cli request-phone-code <phone-number>

login

获取用户账户的认证令牌。此令牌是执行授权操作所必需的。

galoy-cli login <phone-number> <phone-code>

pay

使用指定的支付方式和详情执行支付。您可以选择用比特币（BTC）或美元进行支付。

galoy-cli pay [OPTIONS] --wallet <WALLET>

选项

-u, --username <USERNAME>: The username associated with the recipient's account.
-o, --onchain-address <ONCHAIN_ADDRESS>: The recipient's on-chain Bitcoin address.
-l, --ln-payment-request <LN_PAYMENT_REQUEST>: The Lightning Network payment request for the recipient.
-w, --wallet <WALLET>: Specify the currency wallet to use for the payment. Possible values: btc, usd.
-c, --cents <CENTS>: The payment amount in cents (for USD payments).
-s, --sats <SATS>: The payment amount in satoshis (for BTC payments).
-m, --memo <MEMO>: An optional memo to attach to the payment.

要查看每个命令及其可用选项的详细信息，请使用 help 子命令后跟特定的命令名称。

galoy-cli <command-name> --help

请记住，您始终可以参考 galoy-cli --help 命令以查看所有可用命令、选项和默认 API 端点的摘要。

galoy-cli --help

配置

默认情况下，galoy-cli 配置为与 Galoy 后端的主网生产环境交互，地址为 api.mainnet.galoy.io。但是，开发者可以根据需要切换到不同的环境。

更改 API 端点

要更改 galoy-cli 交互的 API 端点，您可以设置 GALOY_API 环境变量。这对于针对不同环境进行测试或使用 Galoy 后端的本地开发实例特别有用。

例如，要切换到测试环境，可以将 GALOY_API 环境变量设置为 https://api.staging.galoy.io/graphql

export GALOY_API=https://api.staging.galoy.io/graphql
galoy-cli <command>

如果您正在开发 Galoy 后端的本地实例，可以将 API 端点设置为您的本地实例的 URL。例如，如果您的本地 Galoy 后端在端口 4002 上运行，则可以将 GALOY_API 设置为 https://127.0.0.1:4002/graphql

通过设置 API 端点为您的本地实例，您可以在受控环境中测试和开发自己的数据。

贡献

贡献是开源社区如此神奇的地方，可以学习、灵感和创造。您所做的任何贡献都将受到高度重视。我们欢迎社区对 galoy-cli 的贡献，以提高其功能性和用户体验。无论您是想修复错误、实现新功能还是增强文档，您的贡献对我们来说都非常有价值。

指南

• 遵循项目中使用的现有代码风格和约定。
• 保持您的拉取请求集中。如果您正在解决多个问题或功能，请考虑为清晰起见创建单独的 PR。
• 确保您的更改得到良好的文档记录，并添加或更新任何必要的文档。
• 如果您正在引入新功能或功能，请考虑添加相应的测试以保持代码质量。

许可

在 MIT 许可下分发。有关更多信息，请参阅 LICENSE。

联系