Add documentation to the cli within the helper mode. #225
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit add documentation to the cli. The cli will now show the following documentation when prompted without arguments: ```bash (dora3.10) ~/D/C/dora ❯❯❯ dora-cli (dora3.10) cli-documentation ✭ ✱ dora-rs cli client Usage: dora-cli <COMMAND> Commands: check Check if the coordinator and the daemon is running graph Generate a visualization of the given graph using mermaid.js. Use --open to open browser build Run build commands provided in the given dataflow new Generate a new project, node or operator. Choose the language between Rust, Python, C or C++ up Spawn a coordinator and a daemon destroy Destroy running coordinator and daemon. If some dataflows are still running, they will be stopped first start Start the given dataflow path. Attach a name to the running dataflow by using --name stop Stop the given dataflow UUID. If no id is provided, you will be able to choose between the running dataflows list List running dataflows help Print this message or the help of the given subcommand(s) Options: -h, --help Print help information -V, --version Print version information ```
haixuanTao
added a commit
that referenced
this pull request
Mar 22, 2023
* [Make dora-rs publishable on crates.io](#211) * [Add an internal cli argument to create template with path dependencies](#212) * [Avoid blocking the daemon main loop by using unbounded queue](#230) * [Inject YAML declared env variable into the runtime](#227) * [Use rustls instead of system SSL implementation](#216) * [Refactor python error](#229) * [The first letter of rust should be lowercase in the command](#226) * [Add documentation to the cli within the helper mode](#225) * [Update to safer-ffi v0.1.0-rc1](#218) * [remove unused variable: data_bytes](#215) * [Clean up: Remove workspace path](#210) * [Decouple opentelemetry from tracing](#222) * [Remove zenoh dependency from dora node API to speed up build](#220) * [Update to Rust v1.68](#221) * [Deny unknown fields to avoid typos](#223)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR add documentations to the cli. The cli will now show the following documentation when prompted without arguments: