st2 --version

st2 3.9.0, on Python 3.10.12

st2 --help

usage: st2 [-h] [--version] [--url BASE_URL] [--auth-url AUTH_URL]
           [--api-url API_URL] [--stream-url STREAM_URL]
           [--api-version API_VERSION] [--cacert CACERT]
           [--basic-auth BASIC_AUTH] [--config-file CONFIG_FILE]
           [--print-config] [--skip-config] [--debug]
           {run,action,action-alias,auth,login,whoami,apikey,execution,inquiry,key,pack,policy,policy-type,rule,webhook,timer,runner,sensor,trace,trigger,trigger-instance,rule-enforcement,workflow,service-registry,role,role-assignment}
           ...

usage: st2 login [-h] [-j] [-y] [-p PASSWORD] [-l TTL] [-w] username

Authenticate user, acquire access token, and update CLI config directory

positional arguments:
  username              Name of the user to authenticate.

options:
  -h, --help            show this help message and exit
  -j, --json            Print output in JSON format.
  -y, --yaml            Print output in YAML format.
  -p PASSWORD, --password PASSWORD
                        Password for the user. If password is not provided, it
                        will be prompted for.
  -l TTL, --ttl TTL     The life span of the token in seconds. Max TTL
                        configured by the admin supersedes this.
  -w, --write-password  Write the password in plain text to the config file
                        (default is to omit it)

$ st2 login st2admin -p q1w2e3r4
Logged in as st2admin

Note: You didn't use --write-password option so the password hasn't been stored in the client config and you will need to login again in 24 hours when the auth token expires.
As an alternative, you can run st2 login command with the "--write-password" flag, but keep it mind this will cause it to store the password in plain-text in the client config file (~/.st2/config).

[credentials]
username = st2admin
password = q1w2e3r4

usage: st2 auth [-h] [-j] [-y] [-p PASSWORD] [-l TTL] [-t] username

Authenticate user and acquire access token.

options:
  -h, --help            show this help message and exit
  -j, --json            Print output in JSON format.
  -y, --yaml            Print output in YAML format.
  -p PASSWORD, --password PASSWORD
                        Password for the user. If password is not provided, it
                        will be prompted for.
  -l TTL, --ttl TTL     The life span of the token in seconds. Max TTL
                        configured by the admin supersedes this.
  -t, --only-token      On successful authentication, print only token to the
                        console.

usage: st2 whoami [-h] [-j] [-y]

Display the currently authenticated user

options:
  -h, --help  show this help message and exit
  -j, --json  Print output in JSON format.
  -y, --yaml  Print output in YAML format.

Currently logged in as "st2admin".

Authentication method: authentication token
Authentication token expire time: 2026-10-20T10:41:58Z

RBAC:
 - Enabled: False
 - Roles:

usage: st2 run [-t TOKEN] [--api-key API_KEY] [-j] [-y] [-h] [--with-schema]
               [--raw] [--show-tasks] [--depth DEPTH] [-w WIDTH [WIDTH ...]]
               [[--attr ATTR [ATTR ...] | -d | [-k KEY | --delay DELAY |]
               --tail | --auto-dict]] [--trace-tag TRACE_TAG]
               [--trace-id TRACE_ID] [-a] [-e] [-u USER]
               [ref-or-id] [parameters ...]

Invoke an action manually.

positional arguments:
  ref-or-id             Action reference (pack.action_name) or ID of the
                        action.
  parameters            List of keyword args, positional args, and optional
                        args for the action.

options:
  -t TOKEN, --token TOKEN
                        Access token for user authentication. Get
                        ST2_AUTH_TOKEN from the environment variables by
                        default.
  --api-key API_KEY     Api Key for user authentication. Get ST2_API_KEY from
                        the environment variables by default.
  -j, --json            Print output in JSON format.
  -y, --yaml            Print output in YAML format.
  -h, --help            Print usage for the given action.
  --attr ATTR [ATTR ...]
                        List of attributes to include in the output. "all" or
                        unspecified will return all attributes.
  -d, --detail          Display full detail of the execution in table format.
  -k KEY, --key KEY     If result is type of JSON, then print specific key-
                        value pair; dot notation for nested JSON is supported.
  --delay DELAY         How long (in milliseconds) to delay the execution
                        before scheduling.
  --tail                Automatically start tailing new execution.
  --auto-dict           Automatically convert list items to dictionaries when
                        colons are detected. (NOTE - this parameter and its
                        functionality will be deprecated in the next release
                        in favor of a more robust conversion method)
  --trace-tag TRACE_TAG, --trace_tag TRACE_TAG
                        A trace tag string to track execution later.
  --trace-id TRACE_ID   Existing trace id for this execution.
  -a, --async           Do not wait for action to finish.
  -e, --inherit-env     Pass all the environment variables which are
                        accessible to the CLI as "env" parameter to the
                        action. Note: Only works with python, local and remote
                        runners.
  -u USER, --user USER  User under which to run the action (admins only).

$ st2 run core.local -- date -R
.
id: 6ad5f8bd5da20c42c4c374e7
action.ref: core.local
context.user: st2admin
parameters:
  cmd: date -R
status: succeeded
result:
  stdout: Mon, 19 Oct 2026 11:02:21 +0000
  succeeded: true

$ st2 run -a demo.greet name=ops        # -a 异步提交，不等待结果
$ st2 run -j core.http url=https://docs.stackstorm.com method=GET   # -j JSON 输出
$ st2 run --tail demo.roll_call name=ops   # 提交后自动跟踪工作流输出

usage: st2 action [-h]
                  {list,get,create,update,delete,clone,enable,disable,execute}
                  ...

positional arguments:
  {list,get,create,update,delete,clone,enable,disable,execute}
                        List of commands for managing actions.
    list                Get the list of actions.
    get                 Get individual action.
    create              Create a new action.
    update              Updating an existing action.
    delete              Delete an existing action.
    clone               Clone a new action.
    enable              Enable an existing action.
    disable             Disable an existing action.
    execute             Invoke an action manually.

positional arguments:
  {list,get,re-run,cancel,pause,resume,tail}
                        List of commands for managing action executions.
    list                Get the list of the 50 most recent action executions.
    get                 Get individual action execution.
    re-run              Re-run a particular action.
    cancel              Cancel action executions.
    pause               Pause action executions (workflow executions only).
    resume              Resume action executions (workflow executions only).
    tail                Tail output of a particular execution.

$ st2 execution list -n 5          # 最近 5 条
$ st2 execution get 6ad5f9209fab15a925cf572e
$ st2 execution re-run 6ad5f9209fab15a925cf572e
$ st2 execution tail 6ad5f9209fab15a925cf572e

usage: st2 workflow inspect [-h] [--file FILE | --action ACTION]

Inspect workflow definition and return the list of errors if any.

options:
  -h, --help       show this help message and exit
  --file FILE      Local file path to the workflow definition.
  --action ACTION  Reference name for the registered action. This option works
                   only if the file referenced by the entry point is installed
                   locally under /opt/stackstorm/packs.

$ st2 workflow inspect --file /opt/stackstorm/packs.dev/demo/actions/workflows/roll_call.yaml
No errors found in workflow definition.

usage: st2 inquiry [-h] {list,get,respond} ...

Inquiries provide an opportunity to ask a question and wait for a response in
a workflow.

positional arguments:
  {list,get,respond}  List of commands for managing inquiries.
    list              Get the list of the 50 most recent inquiries.
    get               Get individual inquiry.
    respond           Respond to an inquiry.

positional arguments:
  {list,get,create,update,delete,clone,enable,disable}
                        List of commands for managing rules.
    list                Get the list of the 50 most recent rules.
    get                 Get individual rule.
    create              Create a new rule.
    update              Updating an existing rule.
    delete              Delete an existing rule.
    clone               Clone a new rule.
    enable              Enable an existing rule.
    disable             Disable an existing rule.

$ st2 rule delete demo.timer_greet
Resource with id "demo.timer_greet" has been successfully deleted.

usage: st2 timer [-h] {list,get} ...

Timers.

positional arguments:
  {list,get}  List of commands for managing timers.
    list      Get the list of timers.
    get       Get individual timer.

+--------------------------+----------------------+------+----------------------+--------------------+----------------------+
| id                       | uid                  | pack | name                 | type               | parameters           |
+--------------------------+----------------------+------+----------------------+--------------------+----------------------+
| 6ad5f8e95da20c42c4c374ec | trigger:core:ae7e44d | core | ae7e44d2-093e-4626-  | core.st2.CronTimer | {'minute': '*/2',    |
|                          | ...                  |      | 8478-85683493dd4b    |                    | 'timezone': 'UTC'}   |
+--------------------------+----------------------+------+----------------------+--------------------+----------------------+

usage: st2 trigger [-h] {list,get,create,update,delete,clone,getspecs} ...
    list                Get the list of triggers.
    get                 Get individual trigger.
    create              Create a new trigger.
    update              Updating an existing trigger.
    delete              Delete an existing trigger.
    clone               Clone a new trigger.
    getspecs            Return Trigger Specifications of a Trigger.

usage: st2 trigger-instance [-h] {list,get,re-emit} ...
    list              Get the list of the 50 most recent triggerinstances.
    get               Get individual trigger instance.
    re-emit           Re-emit a particular trigger instance.

usage: st2 webhook [-h] {list,get} ...
    list      Get the list of webhooks.
    get       Get individual webhook.

usage: st2 sensor [-h] {list,get,enable,disable} ...
    list                Get the list of sensortypes.
    get                 Get individual sensor.
    enable              Enable an existing sensor.
    disable             Disable an existing sensor.

usage: st2 runner [-h] {list,get,enable,disable} ...
    list                Get the list of runners.
    get                 Get individual runner.
    enable              Enable an existing runner.
    disable             Disable an existing runner.

usage: st2 rule-enforcement [-h] {list,get,create,update,delete,clone} ...
    list                Get the list of the 50 most recent rule enforcements.
    get                 Get individual rule enforcement.
    create              Create a new rule enforcement.
    update              Updating an existing rule enforcement.
    delete              Delete an existing rule enforcement.
    clone               Clone a new rule enforcement.

usage: st2 pack [-h] {list,get,show,search,install,remove,register,config} ...

positional arguments:
  {list,get,show,search,install,remove,register,config}
                        List of commands for managing packs.
    list                Get the list of packs.
    get                 Get information about an installed pack.
    show                Get information about an available pack from the
                        index.
    search              Search the index for a pack with any attribute
                        matching the query.
    install             Install new packs.
    remove              Remove packs.
    register            Register pack(s): sync all file changes with DB.
    config              Configure a pack based on config schema.

$ st2 pack list
+---------+---------+--------------------------------+---------+------------------+
| ref     | name    | description                    | version | author           |
+---------+---------+--------------------------------+---------+------------------+
| chatops | chatops | ChatOps integration pack       | 3.9.0   | StackStorm, Inc. |
| core    | core    | Basic core actions.            | 3.9.0   | StackStorm, Inc. |
| default | default | Default pack where all         | 3.9.0   | StackStorm, Inc. |
|         |         | resources created using the    |         |                  |
|         |         | API with no pack specified get |         |                  |
|         |         | saved.                         |         |                  |
| demo    | demo    | 入门示例 pack：脚本动作、Orquesta | 1.0.0   | admin            |
|         |         | 工作流与定时规则               |         |                  |
| linux   | linux   | Generic Linux actions          | 3.9.0   | StackStorm, Inc. |
| packs   | packs   | Pack management functionality. | 3.9.0   | StackStorm, Inc. |
+---------+---------+--------------------------------+---------+------------------+

$ st2 pack register demo
+--------------+-------+
| Property     | Value |
+--------------+-------+
| actions      | 2     |
| aliases      | 0     |
| configs      | 0     |
| policies     | 0     |
| policy_types | 3     |
| rule_types   | 2     |
| rules        | 0     |
| runners      | 14    |
| sensors      | 0     |
| triggers     | 0     |
+--------------+-------+

usage: st2 key [-h] {list,get,delete,clone,set,load,delete_by_prefix} ...

positional arguments:
  {list,get,delete,clone,set,load,delete_by_prefix}
                        List of commands for managing key value pairs.
    list                Get the list of the 50 most recent key value pairs.
    get                 Get individual key value pair.
    delete              Delete an existing key value pair.
    clone               Clone a new key value pair.
    set                 Set an existing key value pair.
    load                Load a list of key value pairs from file.
    delete_by_prefix    Delete KeyValue pairs which match the provided prefix

usage: st2 key list [-h] [-t TOKEN] [--api-key API_KEY] [-j] [-y]
                    [-a ATTR [ATTR ...]] [-w WIDTH [WIDTH ...]]
                    [--prefix PREFIX] [-d] [-s SCOPE] [-u USER] [-n LAST]

Get the list of the 50 most recent key value pairs.

options:
  -h, --help            show this help message and exit
  -t TOKEN, --token TOKEN
                        Access token for user authentication. Get
                        ST2_AUTH_TOKEN from the environment variables by
                        default.
  --api-key API_KEY     Api Key for user authentication. Get ST2_API_KEY from
                        the environment variables by default.
  -j, --json            Print output in JSON format.
  -y, --yaml            Print output in YAML format.
  -a ATTR [ATTR ...], --attr ATTR [ATTR ...]
                        List of attributes to include in the output. "all"
                        will return all attributes.
  -w WIDTH [WIDTH ...], --width WIDTH [WIDTH ...]
                        Set the width of columns in output.
  --prefix PREFIX       Only return values with names starting with the
                        provided prefix.
  -d, --decrypt         Decrypt secrets and displays plain text.
  -s SCOPE, --scope SCOPE
                        Scope item is under. Example: "user".
  -u USER, --user USER  User for user scoped items (admin only).
  -n LAST, --last LAST  List N most recent key value pairs. Use -n -1 to fetch
                        the full result set.

usage: st2 policy [-h] {list,get,create,update,delete,clone} ...
    list                Get the list of policies.
    get                 Get individual policy.
    create              Create a new policy.
    update              Updating an existing policy.
    delete              Delete an existing policy.
    clone               Clone a new policy.

usage: st2 policy-type [-h] {list,get} ...
    list      Get the list of policy types.
    get       Get individual policy type.

+--------------------------+---------------+------------------+---------------------------------+
| id                       | resource_type | name             | description                     |
+--------------------------+---------------+------------------+---------------------------------+
| 6ad5f3f7c9f37d18c953cada | action        | concurrency      | Limits the concurrent           |
|                          |               |                  | executions for the action.      |
| 6ad5f3f7c9f37d18c953cadb | action        | concurrency.attr | Limits the concurrent           |
|                          |               |                  | executions for the action by    |
|                          |               |                  | attribute(s).                   |

usage: st2 apikey [-h] {list,get,create,delete,clone,enable,disable,load} ...
    list                Get the list of api keys.
    get                 Get individual api key.
    create              Create a new api key.
    delete              Delete an existing api key.
    clone               Clone a new api key.
    enable              Enable an existing api key.
    disable             Disable an existing api key.
    load                Load api key from a file.

$ st2 apikey create -m '{"description": "D5 文档实测"}'
+------------+--------------------------------------------------------------+
| Property   | Value                                                        |
+------------+--------------------------------------------------------------+
| id         | 6ad5f65bc9f37d18c953cb40                                     |
| created_at | 2026-10-19T10:52:11.451329Z                                  |
| enabled    | True                                                         |
| key        | YWU3NDM5MTg1OGZkZjc2YWE5OGExNmY1NDJlMTJmMGNhOTgxMDA5ZDhlYmZj |
|            | OTJlYzEyOGViZWEwMWVkOTA3Ng                                   |
| metadata   | {                                                            |
|            |     "description": "D5 \u6587\u6863\u5b9e\u6d4b"             |
|            | }                                                            |
| uid        | api_key:e8c8fc4ce700418aa582b15f4475b3b3a4ca8c8a0b6d6b15fe28 |
|            | 6cf6ea51d4f349259aa69c88eabae0922180bf318e27346387a7e1196dab |
|            | d15526844b7f7ea2                                             |
| user       | st2admin                                                     |
+------------+--------------------------------------------------------------+

$ st2 apikey list
+--------------------------+----------+--------------------------------+
| id                       | user     | metadata                       |
+--------------------------+----------+--------------------------------+
| 6ad5f65bc9f37d18c953cb40 | st2admin | {'description': 'D5 文档实测'} |
+--------------------------+----------+--------------------------------+

usage: st2 role [-h] {list,get} ...
    list      Get the list of the roles.
    get       Get individual role.

usage: st2 role-assignment [-h] {list,get} ...
    list      Get the list of the role assignments.
    get       Get individual role assignment.

usage: st2 service-registry [-h] {group,member} ...
    group         Manage service registry groups
    member        Manage service registry members

+--------------------------+--------------+--------+--------------+
| id                       | name         | system | description  |
+--------------------------+--------------+--------+--------------+
| 6ad5f3f1799beca33fd60325 | admin        | True   | admin        |
+--------------------------+--------------+--------+--------------+

usage: st2 trace [-h] {list,get} ...
    list      Get the list of the 50 most recent traces.
    get       Get individual trace.

usage: st2 action-alias [-h]
                        {list,get,create,update,delete,clone,match,execute,test}
                        ...
    list                Get the list of action aliases.
    get                 Get individual action alias.
    create              Create a new action alias.
    update              Updating an existing action alias.
    delete              Delete an existing action alias.
    clone               Clone a new action alias.
    match               Get the action alias that match the command text.
    execute             Execute the command text by finding a matching action
                        alias.
    execute/test        Execute the command text by finding a matching action
                        alias and format the result.

Usage: st2ctl {start, stop, restart, status}

Usage: st2ctl {restart-component}
positional arguments:
  component           Name of the st2 service to restart.
                      st2actionrunner st2api st2stream st2auth st2garbagecollector st2notifier st2rulesengine st2sensorcontainer st2chatops st2timersengine st2workflowengine st2scheduler

Usage: st2ctl {reopen-log-files}
positional arguments:
  component           Name of the st2 service to reopen the log files for.
                      （组件清单同上）

Usage: st2ctl {reload, clean}
optional arguments:
  --register-all                  Register all.
  --register-triggers             Register all triggers.
  --register-sensors              Register all sensors.
  --register-rules                Register all rules.
  --register-runners              Register all runners.
  --register-actions              Register all actions.
  --register-aliases              Register all aliases.
  --register-policies             Register all policies.
  --register-configs              Register all configuration files.
  --register-setup-virtualenvs    Create Python virtual environments for all the registered packs.
  --register-recreate-virtualenvs (Delete and re-)create Python virtual environments for all the registered packs.

##### st2 components status #####
st2actionrunner is not running.
st2api is not running.
st2stream is not running.
st2auth is not running.
st2garbagecollector is not running.
st2notifier is not running.
st2rulesengine is not running.

st2ctl reload --register-all          # 等价于全量内容注册（底层调 st2-register-content）
st2ctl restart st2api                 # 重启单个组件
st2ctl status                         # 组件状态

usage: st2-generate-symmetric-crypto-key [-h] -k KEY_PATH [-f]

Tool for crypto key generation.

options:
  -h, --help            show this help message and exit
  -k KEY_PATH, --key-path KEY_PATH
                        Path to file to write key to. Secure permissions of
                        file so only admin can read the crypto key.
  -f, --force           Force rewrite the key file if already exists.

  --register-all                     Register all.
  --register-actions                 注册动作
  --register-aliases                 注册别名
  --register-configs                 注册配置
  --register-policies                注册策略
  --register-rules                   注册规则
  --register-runners                 注册执行器
  --register-sensors                 注册传感器
  --register-notriggers              排除触发器
  --register-pack REGISTER_PACK      仅注册指定 pack
  --register-fail-on-failure         注册失败即退出非零
  --register-setup-virtualenvs       为 pack 创建 Python 虚拟环境
  --register-recreate-virtualenvs    删除并重建虚拟环境

usage: st2-rule-tester [-h] [--config-dir DIR] [--config-file PATH] [--debug]
                       ... [--offline] [--rule RULE] [--rule-ref RULE_REF]
                       [--trigger-instance TRIGGER_INSTANCE]
                       [--trigger-instance-id TRIGGER_INSTANCE_ID] ...

options:
  --rule RULE                         本地规则文件路径
  --rule-ref RULE_REF                 已注册规则的 ref
  --trigger-instance TRIGGER_INSTANCE
                                      本地触发器实例样本文件（JSON/YAML）
  --trigger-instance-id TRIGGER_INSTANCE_ID
                                      用历史触发器实例 ID 测试
  --offline                           离线模式（不连数据库）

usage: st2-trigger-refire [-h] ... [--trigger-instance-id TRIGGER_INSTANCE_ID]
                          ...

按 --trigger-instance-id 把历史触发器实例重新注入平台，重新走一遍规则匹配（排障与重放利器）。

usage: st2-track-result [-h] [--config-dir DIR] [--config-file PATH] [--debug]
                        [--delete] ... id

positional arguments:
  id                    ID of the action execution.

options:
  --delete              跟踪结束后删除跟踪记录

usage: st2-validate-pack-config [-h] ... [--config-path CONFIG_PATH]
                                [--schema-path SCHEMA_PATH] ...

options:
  --config-path CONFIG_PATH
                        Path to the config file to validate.
  --schema-path SCHEMA_PATH
                        Path to the config schema to use for validation.

usage: st2-apply-rbac-definitions [-h] [--config-dir DIR] [--config-file PATH] [--debug] ...
# 把 /opt/stackstorm/rbac/ 下的角色/赋权 YAML 应用到系统（RBAC 启用后每次修改定义后执行）

usage: st2-bootstrap-rmq [-h] [--config-dir DIR] [--config-file PATH] [--debug] ...
# 初始化 RabbitMQ：创建 st2 专用账号与消息队列拓扑（部署初始化用，日常不重复执行）

$ st2-self-check -h
Usage: /usr/bin/st2-self-check

Options:
  -o  Skip Orquesta tests
  -w  Run Windows tests
  -b Which branch of st2tests to use (defaults to master)

$ st2-run-pack-tests -h
# 在 pack 目录内运行其自带测试套件（pytest 封装，配合 st2tests 测试内容包）