跳过主要内容

cli

概览

dora-rs cli 客户端

用法: dora <COMMAND>

命令:
check 检查协调器和守护程序是否正在运行
graph 使用 mermaid.js 生成给定图形的可视化 Use --open to open
browser
build Run build commands provided in the given dataflow
new Generate a new project or node. Choose the language between Rust, Python, C or
C++
up Spawn coordinator and daemon in local mode (with default config)
destroy Destroy running coordinator and daemon. 如果某些数据流仍在运行,则它们将首先停止
start 启动给定数据流路径 使用 --name 附加一个名称至运行中的数据流
stop 停止给定数据流UUID 如果没有提供ID,您将在运行中的数据流之间选择
list 列表出运行中的数据流
logs 显示一个给定数据流和节点日志
daemon 运行守护进程
runtime 运行运行时
coordinator 运行协调器
help 打印本帮助信息或给定子命令的帮助信息

选项:
-h, --help 打印帮助信息
-V, --version 打印版本信息

up

Spawn coordinator and daemon in local mode (with default config)

Usage: dora up

Options:
-h, --help Print help

new

Generate a new project or node. Choose the language between Rust, Python, C or C++

Usage: dora new [OPTIONS] <NAME>

Arguments:
<NAME> Desired name of the entity

Options:
--kind <KIND> The entity that should be created [default: dataflow] [possible values:
dataflow, custom-node]
--lang <LANG> The programming language that should be used [default: rust] [possible values:
rust, python, c, cxx]
-h, --help Print help

start

从给定数据流路径启动。 Attach a name to the running dataflow by using --name

Usage: dora start [OPTIONS] <PATH>

Arguments:
<PATH> Path to the dataflow descriptor file

Options:
--name <NAME> Assign a name to the dataflow
--coordinator-addr <IP> Address of the dora coordinator [default: 127.0.0.1]
--coordinator-port <PORT> Port number of the coordinator control server [default: 6012]
--attach Attach to the dataflow and wait for its completion
--hot-reload Enable hot reloading (Python only)
-h, --help Print help

list

List running dataflows

Usage: dora list [OPTIONS]

Options:
--coordinator-addr <IP> Address of the dora coordinator [default: 127.0.0.1]
--coordinator-port <PORT> Port number of the coordinator control server [default: 6012]
-h, --help Print help

logs

Show logs of a given dataflow and node

Usage: dora logs [OPTIONS] [UUID_OR_NAME] <NAME>

Arguments:
[UUID_OR_NAME] Identifier of the dataflow
<NAME> Show logs for the given node

Options:
--coordinator-addr <IP> Address of the dora coordinator [default: 127.0.0.1]
--coordinator-port <PORT> Port number of the coordinator control server [default: 6012]
-h, --help Print help

check

Check if the coordinator and the daemon is running

Usage: dora check [OPTIONS]

Options:
--dataflow <PATH> Path to the dataflow descriptor file (enables additional checks)
--coordinator-addr <IP> Address of the dora coordinator [default: 127.0.0.1]
--coordinator-port <PORT> Port number of the coordinator control server [default: 6012]
-h, --help Print help

stop

停止给定UUID的数据流。 If no id is provided, you will be able to choose between the running
dataflows

Usage: dora stop [OPTIONS] [UUID]

Arguments:
[UUID] UUID of the dataflow that should be stopped

Options:
--name <NAME> Name of the dataflow that should be stopped
--grace-duration <DURATION> Kill the dataflow if it doesn't stop after the given duration
--coordinator-addr <IP> Address of the dora coordinator [default: 127.0.0.1]
--coordinator-port <PORT> Port number of the coordinator control server [default: 6012]
-h, --help Print help

destroy

销毁运行中的协调器和守护进程。 If some dataflows are still running, they will be stopped
first

Usage: dora destroy [OPTIONS]

Options:
--coordinator-addr <IP> Address of the dora coordinator [default: 127.0.0.1]
--coordinator-port <PORT> Port number of the coordinator control server [default: 6012]
-h, --help Print help

graph

对给定图使用 mermaid.js 生成可视化。 Use --open to open browser

Usage: dora graph [OPTIONS] <PATH>

Arguments:
<PATH> Path to the dataflow descriptor file

Options:
--mermaid Visualize the dataflow as a Mermaid diagram (instead of HTML)
--open Open the HTML visualization in the browser
-h, --help Print help

--version

返回 dora 的当前版本

这个命令将显示 dora 的当前版本。