Support CLI --help command

mui / toolpad

Toolpad: Full stack components and low-code builder for dashboards and internal apps.

https://mui.com/toolpad/

MIT License

964 stars 243 forks source link

Support CLI --help command #1744

Closed Janpot closed 1 year ago

Janpot commented 1 year ago

Summary 💡

npx @mui/toolpad --help

Should print helpful message outlining all possible commands.

npx @mui/toolpad dev --help
npx @mui/toolpad build --help
npx @mui/toolpad start --help

Should each print a helpful message of the sub command

Let's move to yargs to automate this somewhat?
Let's add a npx @mui/toolpad help command as well as an alias for npx @mui/toolpad --help?

apedroferreira commented 1 year ago

Not sure what solution we're using right now for command line arguments, but having something help us with the help command instead of doing it all manually definitely sounds worth it, especially as we add more options. I'm familiar with yargs so I think we could use it.