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

Adapt Plugins for Execution in Visual Navigation Mode πŸ–₯️ #3

Open
s4dhulabs opened this issue Oct 3, 2024 · 1 comment
Assignees
Labels
automation automation rules enhancement New feature or request usability usability

Comments

@s4dhulabs
Copy link
Owner

Description:

In the visual navigation mode, initialized via the start command, users can manage the framework without command-line input, using only arrow keys and shortcuts. This mode will allow users to run plugins in a more user-friendly manner. However, unlike the advanced command-line mode where users specify all execution details, the visual mode requires plugins to have pre-configured values that will be auto-loaded into the argument parser workspace. This will enable users to execute plugins with minimal input, only specifying the scope while other execution details are pre-configured.

Technical Details:

Adapt the YAML configuration of all plugins to include pre-configured parameters.
Implement functionality to auto-load these parameters into the argument parser workspace when a plugin is executed in visual mode. Ensure that the visual mode allows users to execute plugins by simply pressing 'r', with minimal input required.
Current Visual Mode Example:


           *         β ›                     β ›
                      _^_               .
           (( ( ____.Β΄β””β”˜β”`.____  )) ) )  *         *
                    `.β žβ “β Ž.Β΄               .
                     |β”‚β”‚||
                 _ _
                 \\/imana<v0.8>
                  ||-ramewΓΈrk

                     |β”‚β”‚||

    

               about  ◉◍  About the framework
               flush  ◍◉  Remove a recorded resource
               guide  β—β—Ž  Show plugin usage examples and args
                info  β—β—Ž  Show information about plugins
                list  β—β—Ž  List available resources
                load  ◉◍  Load a recorded session (post-analysis)
                 run  β—Žβ—Ž  Run a resource, plugin or case
               start  β—Žβ—Ž  Start Vimana in a interactive mode


vimana start

Proposed Solution:

  • YAML Configuration Adaptation: Modify the YAML configuration files of all plugins to include pre-configured parameters that can be auto-loaded.
  • Parameter Autoloading: Implement functionality to auto-load these parameters into the argument parser workspace when a plugin is executed in visual mode.
  • User Experience Simplification: Ensure that users can execute plugins by pressing 'r', with minimal input required to specify the scope.

Example of YAML Configuration Adaptation:

plugin_name: example_plugin
description: Example plugin description
parameters:
  - name: param1
    type: string
    default: value1
  - name: param2
    type: int
    default: 10
autoload: true

Benefits:

  • Provides a user-friendly interface for executing plugins in visual mode.
  • Simplifies the process of running plugins with pre-configured parameters.
  • Abstracts command-line details, making the framework accessible to users with varying levels of technical expertise.

Future Considerations:

  • Explore additional features for the visual navigation mode, such as customizable shortcuts and themes.
  • Consider integrating with a graphical user interface (GUI) framework for enhanced visual management.
@s4dhulabs s4dhulabs added enhancement New feature or request automation automation rules usability usability labels Oct 3, 2024
@s4dhulabs s4dhulabs self-assigned this Oct 3, 2024
@s4dhulabs
Copy link
Owner Author

Adapt Plugins for Execution in Visual Navigation Mode

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation automation rules enhancement New feature or request usability usability
Projects
None yet
Development

No branches or pull requests

1 participant