cTrader Automate【CLI】

cTrader CLI は、「Automate」アプリと関連機能に機能を絞った cTrader Desktop のコンソール版と考えることができます。以下は、ctrader-cli で作業中にできることの非網羅的なリストです。

• cTrader Desktop自体にアクセスすることなく、アルゴリズムの起動と停止が可能
• 口座とシンボルデータにアクセスする

cTrader CLI のコマンド

他のコマンドラインツールと同様に、cTrader CLIは、ユーザーがコマンドラインインターフェースに特定の定義済みコマンドを発行することで操作できます。

ctrader-cli.exe periods

コマンドには、名前付きオプションと名前なし引数を指定できます。

• オプションは通常、–（その後に完全なオプション名が続く）または-（その後に短縮オプ ション名が続く）で始まります。
• 引数の値は、名前や表記を追加することなく、「そのまま」タイプされます。

ctrader-cli.exe metadata C://Users/{username}/Documents/cAlgo/Sources/Robots/mycoolcbot.algo

このコマンドは、metadataコマンドの後にファイルパスを指定したアルゴリズムに関する重要なメタデータを出力する。この情報には、アルゴリズム名、タイプ、パラメータ、最終ビルド時間が含まれます。

ctrader-cli.exe accounts --ctid=test@email.com --pwd-file=C:/password/password.pwd

コマンドは、指定されたcTIDにリンクされているすべてのアカウントに関するデータを出力する必要があります。

コマンドの全リストとサポートされている引数については、以下の表を参照してください。

指定されたコマンドの必須でないオプションは、すべて［角括弧］で示しています。

cTrader CLIの起動方法

cTrader CLIは、通常の cTrader Desktop と共にデフォルトでインストールされます。

以下の3通りの方法でアクセスできます。

① cTraderから

ctrader-cli 経由で cBot インスタンスを実行するには、cTrader デスクトップで、そのインスタンスを右クリックします。

クリックすると以下のメニューが表示されます。

「外部プロセスで開始」をクリックすると、ctrader-cliが起動します。起動すると、サービスは元々アタッチされているチャート上で選択したインスタンスを実行します。

② コマンドラインから

ctrader-cliには、適切なコマンドラインインターフェイス（Windowsの検索バーに「cmd」と入力するなど）を開いてアクセスできます。

インターフェイスで、ctrader-cli.exeファイルのあるフォルダに移動します。通常、このパスはWindowsマシンでは以下のようになります。

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

正しいフォルダに移動したら、コマンドラインインターフェイスで有効なコマンドを入力して実行します。

③ PATH変数経由

最後に、Windowsの場合、ctrader-cliをPATH環境変数に追加することができます。

どのフォルダにいても、適切なコマンドラインインターフェイスでctrader-cliコマンドを使用できるようになります。

以下の操作を行います。

1. Windowsの検索バーに’env’と入力し、’Edit the system environment variables’を選択
2. 新しく表示されたウィンドウで、「環境変数」をクリック
3. ユーザー名}のユーザー変数」セクションで「パス」を選択し、「編集」をクリック
4. 「新規」ボタンを押し、ctrader-cli.exeファイルのフルパスをテキストフィールドに貼り付け

その後、適当なコマンドラインインターフェイスを開きます。これで、どのフォルダからでもctrader-cliコマンドを実行できます。

一般的な使用例

以下は、一般的な操作を実行するために実行できる一般的なコマンドのリストです。

すべてのシンボルの取得

ctrader-cli.exe symbols --ctid=test@email.com --pwd-file=C:/password/password.pwd

アルゴのメタデータを取得する

ctrader-cli.exe metadata C:/RSI_cBot.algo

metadataコマンドを実行したときに得られる出力の例です。ご覧のように、この出力には、cBotパラメータの名前（これらの名前は–CustomParameter1オプションで使用できます）、タイプ、デフォルト値など、すべての重要な情報が表示されます。

{
  "Name": "RSI_cBot",
  "Type": "cBot",
  "AccessRights": "None",
  "BuildTime": "2023-05-11T16:42:56.7421508+03:00",
  "Parameters": [
    {
    "PropertyName": "Quantity",
    "FriendlyName": "Quantity (Lots)",
    "GroupName": "Volume",
    "Type": "Double",
    "DefaultValue": 1.0,
    "MinValue": 0.01
    },
    {
    "PropertyName": "Source",
    "FriendlyName": "Source",
    "GroupName": "RSI",
    "Type": "DataSeries",
    "DefaultValue": {
        "OwnerId": "00000000-0000-0000-0000-000000000000",
        "FriendlyName": "Close",
        "IsStandard": true
    }
    },
    {
    "PropertyName": "Periods",
    "FriendlyName": "Periods",
    "GroupName": "RSI",
    "Type": "Integer",
    "DefaultValue": 14
    }
  ]
}

デフォルトのパラメータでcBotを実行する

ctrader-cli.exe run C:\mycoolbot.algo -c=test@email.com --pwd-file=C:\password\password.pwd --account=1209201 --symbol=EURUSD --period=h1 

カスタムパラメータでcBotを実行する

ctrader-cli.exe run C:\mycoolbot.algo -c=test@email.com --pwd-file=C:\password\password.pwd --account=1209201 --symbol=EURUSD --period=h1 --ConsolidationPeriods=3 --Periods=15 

保存されたプリセットのパラメータを使用してcBotを実行する

ctrader-cli.exe run C:\mycoolbot.algo C:\coolbotsettings.cbotset -c=test@email.com --pwd-file=C:\password\password.pwd --account=1209201 --symbol=EURUSD --period=h1 

cTrader CLI のAutomate API

以下の表は、特定の Automate API メンバーでのcTrader CLI の動作をまとめたものです。

要約

cTrader CLIは、コマンドライン(と対話できる任意のカスタムインターフェース)を使用してcBotを管理できるため、アルゴリズム取引の範囲を拡大したい人にとって不可欠な機能です。

種々のAPIと併用したり、サードパーティのサービスと併用したり、様々な活用方法があります。