gh-138122: Refactor the CLI of profiling.sampling into subcommands #141813
Conversation
pablogsal
force-pushed
the
gh-138122-2
branch
5 times, most recently
from
0790c5b to
1fcfffc
Compare
pablogsal
force-pushed
the
gh-138122-2
branch
from
1fcfffc to
db2ed3b
Compare
|
@savannahostrowski I have reformulated the CLI to break it into sub commands. Could you play with this a bit and tell me what you think? |
|
CC @lkollar |
…nto subcommands
|
@hugovk if you have some time can you play with the CLI and tell be if you see any improvements we could do? |
savannahostrowski
left a comment
savannahostrowski
left a comment
There was a problem hiding this comment.
This refactoring makes the UX so much less intimidating off the jump IMO. I really like what it does for help tbh. Makes things a bit more intuitive!
One suggestion around how we can clean up examples in the help but otherwise, LGTM!
| attach Attach to and profile a running process | ||
| live Interactive TUI profiler (top-like interface) | ||
| Examples: |
There was a problem hiding this comment.
With subcommands, it'd be nice to pull some of these examples into the subcommand help. I'd suggest maybe keeping one example for each run/attach/live in general help and then moving all the others into the right contextual command.
I think that should help with readability of all the examples here, while still giving folks inline guidance.
| Commands: | ||
| run Run and profile a script or module | ||
| attach Attach to and profile a running process | ||
| live Interactive TUI profiler (top-like interface) |
There was a problem hiding this comment.
Hmm maybe live should be a --live flag on run and attach since itself can run and attach? Isn't it more like an output type?
There was a problem hiding this comment.
Ah good point indeed! Yeah I think this makes sense. I wanted to give this a bit more protagonism but it's true that the model doesn't really match
hugovk
changed the title
3 participants
Uh oh!
There was an error while loading. Please reload this page.