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

Enable Command Aliases for Easier CLI Usage in Future Releases #6

Open
s4dhulabs opened this issue Oct 10, 2024 · 0 comments
Open

Enable Command Aliases for Easier CLI Usage in Future Releases #6

s4dhulabs opened this issue Oct 10, 2024 · 0 comments
Assignees
Labels
CLI enhancement New feature or request usability usability

Comments

@s4dhulabs
Copy link
Owner

Description:

Currently, the Vimana Framework requires users to type long command lines to execute various operations. For example:

$ vimana run \
	--module dmt \
	--target-list 127.0.0.1, 192.168.1.161, djapp1.vmnf.com\
	--port-list 8888,9001,8000,5001 \
	--verbose \
	--auto \
	--save-case djapps \
	--exec-case

To improve user experience and make the command-line interface (CLI) more user-friendly, we propose adding support for command aliases in future releases. This will allow users to execute commands using shorter, more intuitive aliases. For example:

  • vfrp for vimana run --plugin
  • vfrc for vimana run --case
  • vfgp for vimana guide --plugin

Expected Behavior:

  • Users should be able to use shorter aliases to execute commands.
  • The setup script should automatically configure these aliases in the user's shell configuration (~/.bashrc or ~/.zshrc).

Proposed Solution:

  • Implement a script that sets up aliases for common commands.
  • Ensure the setup script adds these aliases to the user's shell configuration file.
  • Provide clear documentation on how to use the aliases.

Example Aliases:

  • vfrp for vimana run --plugin
  • vfrc for vimana run --case
  • vfgp for vimana guide --plugin

Additional Context: This feature will significantly enhance the usability of the Vimana Framework, making it more accessible and efficient for users. It is especially useful for users who frequently run complex commands and need a quicker way to execute them.

@s4dhulabs s4dhulabs self-assigned this Oct 10, 2024
@s4dhulabs s4dhulabs added enhancement New feature or request usability usability CLI labels Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLI enhancement New feature or request usability usability
Projects
None yet
Development

No branches or pull requests

1 participant