Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the usage of the CLI #226

Closed
5 tasks
Tracked by #147
shekohex opened this issue Aug 15, 2024 · 0 comments · Fixed by #228
Closed
5 tasks
Tracked by #147

Document the usage of the CLI #226

shekohex opened this issue Aug 15, 2024 · 0 comments · Fixed by #228
Assignees
@shekohex
Labels
documentation

Comments

@shekohex
Copy link
Contributor

shekohex commented Aug 15, 2024 •
edited
Loading

Overview

We want to update the documentation on how to use the CLI and add a detailed usage in the README of the cli directory. The end goal for this task is to have a readme that covers the following:

  • How to install the CLI from crates.io
  • How to use the CLI to create a new blueprint/gadget.
  • How to use the CLI to deploy the blueprint to a local Tangle node.
  • What are the required ENVs for the deployment
  • With each step, give an example and the expected output.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shekohex shekohex

Labels
documentation
Projects
Webb Universe
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add CLI usage documentation to README shekohex/gadget
1 participant
@shekohex