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

[feat] Real Time Command Usage Hint in the terminal #36

Open
shubhdevelop opened this issue Oct 3, 2024 · 2 comments · May be fixed by #48
Open

[feat] Real Time Command Usage Hint in the terminal #36

shubhdevelop opened this issue Oct 3, 2024 · 2 comments · May be fixed by #48
Assignees

Comments

@shubhdevelop
Copy link
Contributor

I would like to request a feature for displaying real-time command usage hints while typing in the terminal. This feature would provide users with helpful information about command options and arguments as they type.
Feature Details:

users type a command, the terminal should display relevant command options, flags, or argumen in real-time.
offering quick guidance on how to properly use a command without needing to manually look up documentation.

Example

A user begins typing:

$ myShell: **SET**  

we should hint users with the usage syntax inline like this

$ myShell: **SET**  [[value [NX | XX] [EX seconds | PX milliseconds | EXAT unix-time-seconds | PXAT unix-time-milliseconds | KEEPTTL]',]]

Note:
[[string]] : depicts hints

Benefits:

  • Greatly enhances productivity and ease of use, especially for complex commands with many options.
  • Reduces the need for users to refer to --help or external documentation, making the command-line experience more efficient and user-friendly.
  • Helps users avoid common mistakes by showing the correct syntax and options in real-time.

This request aims to provide an intuitive experience for users, reducing the friction of using unfamiliar or complex commands.

@shubhdevelop
Copy link
Contributor Author

@lucifercr07 can you assign this to me

@Sama-004
Copy link
Contributor

Sama-004 commented Oct 4, 2024

nice idea

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

Successfully merging a pull request may close this issue.

2 participants