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

Make the CLI interactive #30

Open
EmileTrotignon opened this issue Feb 14, 2024 · 1 comment
Open

Make the CLI interactive #30

EmileTrotignon opened this issue Feb 14, 2024 · 1 comment

Comments

@EmileTrotignon
Copy link
Collaborator

Currently, sherlodoc's cli has two mode, single request and "toplevel".

The single request mode works as follow :

$ sherlodoc search "list map"

and return the results of the query "list map".

This is not very practical for a real user, because you need to type "sherlodoc search" over and over to make multiple request (its very good for cram tests though).

We have a "toplevel" mode that is slightly better. With the following command :

$ sherlodoc search

sherlodoc will read queries on stdin each time you press enter, and print the results.

This is not very ergonomic, and we would like something more similar to the website were the results are given on the go when you type. This requires to use some TUI framework like ncurses, because when the user adds a letter you want to remove already print result to print the new ones.

@EmileTrotignon
Copy link
Collaborator Author

I think this could be done with minttea

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

No branches or pull requests

1 participant