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.

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

feat(CLI): Add category and refine help text #707

Merged
merged 2 commits into from
Aug 2, 2022
Merged

feat(CLI): Add category and refine help text #707

merged 2 commits into from
Aug 2, 2022

Conversation

gaocegege
Copy link
Member

The new help text looks like:

 envd - Development environment for data science and AI/ML teams

 Usage:
    envd up --path <path>

    envd run --name <env-name> --command "pip list"

 Build and launch envd environments. Get more information at: https://envd.tensorchord.ai/.
 To get started with using envd, check out the getting started guide: https://envd.tensorchord.ai/guide/getting-started.html.
 
 Advanced Commands:
  pause, p   Pause the envd environment
  resume, r  Resume the envd environment
 Basic Commands:
  build, b          Build the envd environment
  destroy, d        Destroy the envd environment
  envs, env, e      Manage envd environments
  images, image, i  Manage envd images
  run               Spawns a command installed into the environment.
  up, u             Build and run the envd environment
 Management Commands:
  bootstrap  Bootstrap the envd installation
  context    Manage envd contexts
  init, i    Initializes the current directory with the build.envd file
  prune      Clean up the build cache
 Other Commands:
  version, v  Print envd version information

 Global Options:
  --debug     enable debug output in logs (default: false)
  --help, -h  show help (default: false)

Signed-off-by: Ce Gao cegao@tensorchord.ai

Signed-off-by: Ce Gao <cegao@tensorchord.ai>
Signed-off-by: Ce Gao <cegao@tensorchord.ai>
@gaocegege gaocegege merged commit c515f3c into main Aug 2, 2022
@gaocegege gaocegege deleted the apptxt branch August 2, 2022 08:22
@terrytangyuan
Copy link
Member

Cool! It would be great if basic commands show up at the top instead of advanced commands. Should bootstrap be in basic commands instead if it will be used by first users?

@gaocegege
Copy link
Member Author

SGTM.

It is hard to reorg the order of the commands with our CLI frameworks. I will investigate how to achieve this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants