-
-
Notifications
You must be signed in to change notification settings - Fork 76
Description
With increasing wizard flows, I'm leaning towards refactoring the wizard CLI flags. Right now, everything is an option, making it very hard to grasp which options can be used in which combinations.
# correct
npx @sentry/wizard@latest -i nextjs --saas --tracing --logs
npx @sentry/wizard@latest --skills --scope=user
# wrong
npx @sentry/wizard@latest -i nextjs --saas --tracing --logs --scope=user #scope does nothing
npx @sentry/wizard@latest --skills --scope=user --saas # saas does nothingWe could/should leverage sub commands, to clearly differentiate key flows from options.
npx @sentry/wizard@latest install nextjs --saas --tracing --logs
npx @sentry/wizard@latest install skills --scope=userThe cool part about this is that the --help commands will suddenly become much more helpful because they can be called at any sub command level.
I would even make the specific SDK a sub command because we have cases where some SDK setup wizards respect options that others don't (yet, or never).
This becomes especially important with an increasing number of non-SDK setup flows like #1187
The obvious counter argument here is that this is a breaking change and requires close coordination with docs and any other place where we currently publicly document wizard usage. Opening this issue now to gauge some thoughts.