whatwedo/dde

Commands lack useful descriptions

Opened this issue · 1 comments

The current list of commands when running dde, has descriptions for the flags like --autocomplete but no description for the individual commands.

Not all commands are self explaining. Like system:nuke and system:cleanup for example, do not really tell me how much I get into trouble when running these, or whether I get in trouble at all.

It would be helpful if all commands had a description like the two flags have. Or at least, if all commands are described in the readme.

Arguments:
   --autocomplete                  add `eval $(~/dde/dde.sh --autocomplete)`  to  your `~/.zshrc` or `~/.bash_profile`
   --help                          show extended help for command, if exists

System Commands:
   system:cleanup                  
   system:config                   
   system:dde:install              
   system:dde:install:alias        
   system:dde:install:autocomplete 
   system:destroy                  
   system:env                      
   system:exec                     
   system:list                     
   system:log                      
   system:logs                     
   system:nuke                     
   system:services                 
   system:ssh-key-add              
   system:status                   
   system:stop                     
   system:up                       
   system:update                   

Project Commands:
   project:destroy                 
   project:docker-override         
   project:env                     
   project:exec                    
   project:fix-permissions         
   project:log                     
   project:open                    
   project:services                
   project:shell                   
   project:shell:root              
   project:status                  
   project:stop                    
   project:up                      
   project:update                  

Local Commands:

There was once a list with the commands. But yeah, would be very useful to see this in the README as well.

Haha. "Good first issue" - indeed.