Pass variables through CLI (windmill-labs#453)

hcourdent · web-flow · commit adfe2fb48b67 · 2024-01-04T10:41:25.000+01:00
diff --git a/docs/advanced/3_cli/flow.md b/docs/advanced/3_cli/flow.md
@@ -49,9 +49,11 @@ wmill flow run <remote_path> [options]
 
 | Option         | Parameters | Description                                                                   |
 | -------------- | ---------- | ----------------------------------------------------------------------------- |
-| `-d, --data`   | `data`     | Inputs specified as a JSON string or a file using @filename or stdin using @- |
+| `-d, --data`   | `data`     | Inputs specified as a JSON string or a file using @filename or stdin using @- . Resources and variables must be passed using "$res:..." or "$var:..." For example `wmill flow run u/henri/message_to_slack -d '{"slack":"$res:u/henri/henri_slack_perso","channel":"general","text":"hello dear team"}'` |
 | `-s, --silent` |            | Do not ouput anything other then the final output. Useful for scripting.      |
 
+![CLI arguments](../../assets/cli/cli_arguments.png "CLI arguments")
+
 ## Flow specification
 
 You can find the definition of the flow file structure [here](/docs/openflow/index.mdx).
diff --git a/docs/advanced/3_cli/script.md b/docs/advanced/3_cli/script.md
@@ -72,9 +72,11 @@ wmill script run <remote_path> [options]
 
 | Option         | Parameters | Description                                                                   |
 | -------------- | ---------- | ----------------------------------------------------------------------------- |
-| `-d, --data`   | `data`     | Inputs specified as a JSON string or a file using @filename or stdin using @- |
+| `-d, --data`   | `data`     | Inputs specified as a JSON string or a file using @filename or stdin using @- . Resources and variables must be passed using "$res:..." or "$var:..." For example `wmill script run u/henri/message_to_slack -d '{"slack":"$res:u/henri/henri_slack_perso","channel":"general","text":"hello dear team"}'` |
 | `-s, --silent` |            | Do not ouput anything other then the final output. Useful for scripting.      |
 
+![CLI arguments](../../assets/cli/cli_arguments.png "CLI arguments")
+
 ## Remote path format
 
 ```js
diff --git a/docs/assets/cli/cli_arguments.png b/docs/assets/cli/cli_arguments.png
diff --git a/sidebars.js b/sidebars.js
@@ -314,12 +314,12 @@ const sidebars = {
 						'advanced/cli/workspace-management',
 						'advanced/cli/sync',
 						'advanced/cli/user',
+						'advanced/cli/script',
 						'advanced/cli/flow',
 						'advanced/cli/app',
 						'advanced/cli/resource',
 						'advanced/cli/variable',
-						'advanced/cli/folder',
-						'advanced/cli/script'
+						'advanced/cli/folder'
 					]
 				},
 				'advanced/deploy_gh_gl/index',
