Rivet CLI - run
命令
使用提供的输入值在项目中运行Rivet图表。
快速入门
# Run with basic input
npx @ironclad/rivet-cli run my-project.rivet-project --input name=Alice
# Run with JSON input
echo '{"name": "Alice"}' | npx @ironclad/rivet-cli run my-project.rivet-project --inputs-stdin
# Run specific graph
npx @ironclad/rivet-cli run my-project.rivet-project "My Graph" --input name=Alice
描述
run
命令用于执行带有指定输入的 Rivet 图。这在以下情况下特别有用:
- 使用特定输入测试图形
- 将Rivet集成到命令行脚本和工具中
- 从其他编程语言自动化图形执行
- 图形化实现的开发与调试
使用方法
基本用法将运行所提供项目文件中的主图,无需输入任何值:
npx @ironclad/rivet-cli run my-project.rivet-project
你也可以指定文件中的特定图表来运行:
npx @ironclad/rivet-cli run my-project.rivet-project "My Graph"
输入项
输入可以通过两种方式提供。第一种方式是使用--input
标志为每个输入值:
npx @ironclad/rivet-cli run my-project.rivet-project --input input1=5 --input input2=10
这对于基本输入值非常有用,可以方便地测试各种场景。
第二种方法是通过标准输入提供一个JSON对象作为输入。这对于更复杂的输入值非常有用:
echo '{"input1": 5, "input2": 10}' | npx @ironclad/rivet-cli run my-project.rivet-project --inputs-stdin
这对于更复杂的输入值非常有用,比如数组或对象,以及从其他命令或脚本传递输入值。
输出
Rivet CLI 将 JSON 数据输出到标准输出。图中的每个 Graph Output 节点将对应输出 JSON 对象中的一个键。
每个属性的值将是一个Data Value对象,包含一个type
属性和一个value
属性。
例如,如果一个图表有两个Graph Output节点,output1
(字符串类型)和output2
(数字类型),输出的JSON对象将如下所示:
{
"output1": {
"type": "string",
"value": "Hello, World!"
}
"output2": {
"type": "number",
"value": 42
}
}
选项
输入配置
--input
- 为图表指定输入值。可以多次使用。--inputs-stdin
- 从标准输入读取JSON对象作为输入值。会覆盖通过--input
提供的任何输入值。--context
- 为图表指定一个单一的上下文值。可以多次使用。上下文可用于向图表传递全局值。上下文的指定格式与--input
相同。
输出配置
--include-cost
- 在输出的JSON对象中包含图表执行的成本。成本会作为输出JSON上的cost
属性被包含。