设置 cTrader CLI¶

本文介绍如何在 Windows、macOS 或 Linux 上安装 cTrader CLI、创建凭据文件, 以及通过终端或 Docker 容器验证连接。

前提条件 ¶

至少关联一个交易账户的 cTrader ID。
受支持的软件包管理器: Windows 使用 WinGet, macOS 和 Linux 使用 Homebrew。
运行 cBot 需要 .NET 8。通过 cTrader CLI 运行旧版 cBot 之前, 请先在最新版本的 cTrader 桌面应用程序中重新编译。
使用技能需要安装 Node.js 22.20.0 或更高版本。

通过软件包管理器安装 ¶

建议通过软件包管理器安装。软件包管理器会下载适用于你当前操作系统的版本, 并将 ctrader-cli 命令添加到 PATH, 使你可以从任何文件夹运行该命令。

WindowsmacOSLinux

以管理员身份打开 Windows PowerShell 并运行:

winget install Spotware.cTrader.CLI

打开终端并运行:

brew tap spotware/tap https://github.com/spotware/homebrew-tap
brew install spotware/tap/ctrader-cli

如果尚未安装 Homebrew, 请先按照 Homebrew 网站上的说明完成安装。

打开终端并运行:

brew tap spotware/tap https://github.com/spotware/homebrew-tap
brew install spotware/tap/ctrader-cli

如果尚未安装 Homebrew, 请先按照 Homebrew 网站上的说明完成安装。

警告

请仅通过上述 Spotware 官方软件包标识符安装 cTrader CLI。从未经验证的来源安装软件可能危及你的凭据和资金安全。

通过 Docker 镜像安装 ¶

cTrader CLI 以 Linux Docker 镜像形式发布, 便于在 Linux VPS、高性能服务器或云平台上托管 cBot。该镜像也可以通过带 WSL 的 Docker Desktop 在 Windows 上运行。

docker pull ghcr.io/spotware/ctrader-console:latest

cBot 运行指南介绍了如何挂载宿主机文件夹以及通过环境变量传递配置。

提示

cTrader CLI 已随 cTrader 桌面应用程序一起提供, 因此无需单独安装, 即可在外部进程中启动 cBot。

在 Windows 上手动安装 ¶

如果不想在 Windows 上使用软件包管理器, 可以使用 cTrader 桌面应用程序自带的 ctrader-cli 可执行文件。该文件通常位于:

C:\Users\{username}\AppData\Local\Spotware\cTrader\{installationId}

要从任意文件夹运行 cTrader CLI, 请将此目录添加到 PATH:

复制包含 ctrader-cli 的文件夹路径。
在 Windows 开始菜单中搜索环境变量, 然后选择编辑系统环境变量。
在系统属性窗口中选择环境变量。
在用户变量下双击 Path。
选择新建, 粘贴复制的路径, 然后在每个对话框中选择确定以保存设置。

注意

将文件夹添加到 PATH 后, 你就可以在任意位置运行 ctrader-cli, 并在其后附加任意命令。

验证安装 ¶

安装后, 请确认 cTrader CLI 可正常使用。这两条命令均无需登录。

ctrader-cli --version
ctrader-cli --help

如果终端提示找不到命令, 请关闭并重新打开终端以加载更新后的 PATH, 然后重试。

创建凭据文件 ¶

大多数命令都会针对账户执行操作, 因此需要三个值: cTrader ID、密码和账户号码。

项目	选项	说明
cTrader ID	`--ctid` 或 `-c`	cTID 用户名或电子邮箱地址
密码	`--pwd-file`	包含 cTID 密码的文件路径
账户	`--account` 或 `-a`	交易账户号码

为确保安全, 请勿直接在命令中输入 cTrader ID 密码。请将密码保存到文件中, 然后使用 --pwd-file 指向该文件。

打开纯文本编辑器, 例如记事本。
在单独一行中输入 cTrader ID 密码, 开头和结尾均不要留空格。
将文件保存为 .pwd 或 .txt 扩展名, 例如 password.pwd。
在命令中指定该文件: --pwd-file=C:/test/password.pwd。

准备好凭据文件后, 使用两种身份验证方式中的任意一种将其传递给命令。

警告

密码文件会以明文形式保存你的密码。请勿将密码文件存放在共享文件夹或受版本控制的文件夹中。限制读取权限, 并在不再需要时将其删除。

Docker 运行示例 ¶

在容器中, 通过 --mount 将宿主机路径挂载到容器内, 并通过 -e 传递配置值。以下是一个在容器内启动 cBot 的简短示例:

docker run -d -it \
  --name ctrader.console.run.mybot \
  --mount type=bind,src=/cAlgo/Robots,dst=/mnt/Robots \
  -e CTID='mycid' \
  -e PWD-FILE='/mnt/Robots/ctrader-cli.pwd' \
  -e ACCOUNT='9102302' \
  -e SYMBOL='EURUSD' \
  -e PERIOD='H1' \
  ghcr.io/spotware/ctrader-console:latest run "/mnt/Robots/My bot.algo" --environment-variables

如需了解完整的 Docker 操作流程及各选项的对应关系, 请参阅运行和管理 cBot。