On Wed, 2018-05-23 at 11:34 +0200, Viktor Ashirov wrote: > Hi, > > I'd like to continue our discussion about feature parity with perl > tools > and overall user experience of the new CLI tools. > > Here are some projects where we can take inspiration for our own > design: > > * bpython interpreter > https://bpython-interpreter.org/screenshots.html > > * fish shell > http://fishshell.com/docs/current/design.html > > * Python Prompt Toolkit > https://github.com/jonathanslenders/python-prompt-toolkit > (it's used to build tools like pgcli and mycli: https://github.com/ > dbcli) > > * OpenStack CLI: > https://docs.openstack.org/python-openstackclient/pike/cli/commands > .html > https://docs.openstack.org/python-openstackclient/pike/cli/interact > ive.html > > Common theme is that all of these CLIs are primarily used in REPL > mode, > but they can be used in script mode as well. > > Here's the quote from fish shell's design page about the law of > discoverability: > > * Everything should be tab-completable, and every tab completion > should > have a description. > > * Every syntax error and error in a built-in command should contain > an > error message describing what went wrong and a relevant help page. > Whenever possible, errors should be flagged red by the syntax > highlighter. > > * The help manual should be easy to read, easily available from the > shell, complete and contain many examples > > * The language should be uniform, so that once the user understands > the > command/argument syntax, they will know the whole language, and be > able to use tab-completion to discover new features. > Hey there, When building these tools I took a lot of inspriation from the openshift tools actually, but there is a logic to the design. Everything goes from "least specific" to "most specific" So for example, dsctl start <instance> This doesn't make sense because you have a "specific" action, before the "broad concept" of an instance. So everything is in the pattern of: dsctl <instance> start/thing .... dsidm <instance> user create .... Everything goes from least specific to most. I actually did put a lot of work into these based on design principles already. About all we are missing is tab complete, and IIRC there is a python argparse module for that which should work given our design. I don't REPL mode is super important, I don't think I've EVER used a REPL in all my years as a sysadmin because I want to be able to copy paste out whole command sequences. Hope that helps! > Please let me know what do you think. > > Thanks! > > -- > Viktor > _______________________________________________ > 389-devel mailing list -- 389-devel@xxxxxxxxxxxxxxxxxxxxxxx > To unsubscribe send an email to 389-devel-leave@lists.fedoraproject.o > rg > Fedora Code of Conduct: https://getfedora.org/code-of-conduct.html > List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelin > es > List Archives: https://lists.fedoraproject.org/archives/list/389-deve > l@xxxxxxxxxxxxxxxxxxxxxxx/message/QFJVIX5CTRPBA2VPZIEXUDCZG7L2TS2O/ _______________________________________________ 389-devel mailing list -- 389-devel@xxxxxxxxxxxxxxxxxxxxxxx To unsubscribe send an email to 389-devel-leave@xxxxxxxxxxxxxxxxxxxxxxx Fedora Code of Conduct: https://getfedora.org/code-of-conduct.html List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/389-devel@xxxxxxxxxxxxxxxxxxxxxxx/message/GABWBNQO55TW2OE2PZCT5PI3BJZKXC42/
