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

Commands lack useful descriptions #85

Open
renestalder opened this issue Apr 24, 2024 · 1 comment
Open

Commands lack useful descriptions #85

renestalder opened this issue Apr 24, 2024 · 1 comment
Labels
good first issue Good for newcomers

Comments

@renestalder
Copy link

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:
@s4mpl3d s4mpl3d added the good first issue Good for newcomers label Apr 24, 2024
@marcwieland95
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants