-
Notifications
You must be signed in to change notification settings - Fork 234
feat: add docs for repl and prompt modes #3311
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63b0cfd to
c1774ed
Compare
c1774ed to
45a76f3
Compare
45a76f3 to
add5014
Compare
Signed-off-by: Sandy Lai <sandy.lai@salesforce.com>
Signed-off-by: Sandy Lai <sandy.lai@salesforce.com>
Signed-off-by: Sandy Lai <sandy.lai@salesforce.com>
Signed-off-by: Sandy Lai <sandy.lai@salesforce.com>
SandyPantsLai
approved these changes
Jun 11, 2025
Contributor
Author
|
Thank you @SandyPantsLai ! |
tlowrimore-heroku
approved these changes
Jun 11, 2025
Contributor
tlowrimore-heroku
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good, @justinwilaby! The only question I had has already been answered, that being: why --prompt rather than prompt.
k80bowman
approved these changes
Jun 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add REPL and Prompt Command Documentation
Description
This PR adds comprehensive documentation for two interactive features of the Heroku CLI:
The documentation provides clear guidance on how to use these features and their benefits.
Changes
Added
docs/repl.mdwith:Added
docs/prompt.mdwith:Added supporting command files:
src/commands/repl.ts- Guides users to useheroku --replsrc/commands/prompt.ts- Guides users to useheroku <COMMAND> --promptWhy
These documentation additions:
Testing