Skip to content
This repository has been archived by the owner on Oct 31, 2023. It is now read-only.

docs: add top level commands to help text, restructure #608

Merged
merged 1 commit into from Jun 16, 2023
Merged

docs: add top level commands to help text, restructure #608

merged 1 commit into from Jun 16, 2023

Conversation

vados-cosmonic
Copy link
Contributor

Feature or Problem

Add the new top level commands from the ongoing refactoring to the Wasmcloud help text and restructure it.

Help text now looks like this:

_________________________________________________________________________________
                               _____ _                 _    _____ _          _ _
                              / ____| |               | |  / ____| |        | | |
 __      ____ _ ___ _ __ ___ | |    | | ___  _   _  __| | | (___ | |__   ___| | |
 \ \ /\ / / _` / __| '_ ` _ \| |    | |/ _ \| | | |/ _` |  \___ \| '_ \ / _ \ | |
  \ V  V / (_| \__ \ | | | | | |____| | (_) | |_| | (_| |  ____) | | | |  __/ | |
   \_/\_/ \__,_|___/_| |_| |_|\_____|_|\___/ \__,_|\__,_| |_____/|_| |_|\___|_|_|
_________________________________________________________________________________

Interact and manage wasmCloud applications, projects, and runtime environments

Usage: wash [OPTIONS] <COMMAND>

Configure:
  completions  Generate shell completions for wash
  ctx          Manage wasmCloud host configuration contexts
  drain        Manage contents of local wasmCloud caches
  keys         Utilities for generating and managing keys
  claims       Generate and manage JWTs for wasmCloud actors

Build:
  new          Create a new project from template
  build        Build (and sign) a wasmCloud actor, capability provider, or interface
  inspect      Inspect capability provider or actor module
  par          Create, inspect, and modify capability provider archive files

Run:
  up           Bootstrap a local wasmCloud environment
  down         Tear down a local wasmCloud environment (launched with wash up)
  app          Manage declarative applications and deployments (wadm) (experimental)

Iterate:
  start        Start an actor or provider
  link         Link an actor and a provider
  call         Invoke a wasmCloud actor
  stop         Stop an actor or provider, or host
  ctl          Interact with a wasmCloud control interface

Publish:
  pull         Pull an artifact from an OCI compliant registry
  push         Push an artifact to an OCI compliant registry
  reg          Perform operations on an OCI or Bindle registry

Optimize:
  gen          Generate code from smithy IDL files
  lint         Perform lint checks on smithy models
  validate     Perform validation checks on smithy models

Options:
  -o, --output <OUTPUT>  Specify output format (text or json) [default: text]
  -h, --help             Print help
  -V, --version          Print version

Related Issues

#538

Release Information

next

Consumer Impact

Consumers will have a more intuitive help text that maps to the process of using wasmCloud

Testing

Built on platform(s)

  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
  • x86_64-windows

Tested on platform(s)

  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
  • x86_64-windows

Unit Test(s)

Acceptance or Integration

Manual Verification

@vados-cosmonic
Copy link
Contributor Author

vados-cosmonic commented Jun 15, 2023

Note: @brooksmtownsend had some feedback:

  • refactor ordering

connorsmith256
connorsmith256 previously approved these changes Jun 15, 2023
src/main.rs Outdated Show resolved Hide resolved
src/main.rs Outdated Show resolved Hide resolved
Signed-off-by: Victor Adossi <vadossi@cosmonic.com>
Copy link
Member

@brooksmtownsend brooksmtownsend left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@connorsmith256 connorsmith256 merged commit a6a3388 into wasmCloud:main Jun 16, 2023
18 of 20 checks passed
@vados-cosmonic vados-cosmonic deleted the docs/ux/add-flattened-commands-to-help-text branch June 20, 2023 13:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants