Skip to content

README.md

Latest commit

 

History

History
75 lines (57 loc) · 3.12 KB

README.md

File metadata and controls

75 lines (57 loc) · 3.12 KB

ru en

GenerateGUIforCLI

A lightweight tool to generate user-friendly GUIs for command-line applications (CLI) using JSON-based configurations. Perfect for users who prefer graphical interfaces over terminal commands.

Features

  • Convert CLI arguments into intuitive GUI forms (checkboxes, dropdowns, file pickers).
  • JSON-driven configuration — describe CLI parameters once, reuse forever.
  • Run applications directly from the GUI (NW.js/HTA only).

Quick Start

1. Installation

Download and unzip a copy of the entire repository.

2. Running the Tool

Choose one of these methods:

Method Requirements Launch Command
NW.js Install NW.js nw C:\Path\to\app where 'C:\Path\to\app' is a directory where GenerateGUIforCLI is located.
HTA Windows only Double-click generateGUIforCLI.hta
Browser Any modern browser Open generateGUIforCLI.html (limited functionality)

How to Use

Step 1: Prepare a JSON Configuration

Create a JSON file describing your CLI app’s arguments. Follow the JSON Schema or use a pre-made configuration from a trusted source (e.g., community repositories or official tool documentation).

Step 2: Load the JSON File

  1. Open the tool (NW.js/HTA/browser).
  2. Click "Path to CLI arguments description" and select your JSON file.
  3. The GUI will auto-generate input fields based on the JSON.

Step 3: Generate and Execute

  1. Fill in the GUI fields.
  2. Click "Generate Command Line" to preview the CLI command.
  3. (NW.js/HTA only):
    • Specify the executable path.
    • Click "Execute" to run the CLI app with your parameters.
  • ⚠️ Security Note: Before executing, always verify the generated command in the text field. Proceed only if you:
    • Understand exactly what the command does.
    • Confirm it matches your intent (e.g., no unexpected file deletions or risky operations).

JSON Editors

Use these tools to create/edit JSON configurations:

FAQ

Where do I get CLI argument descriptions?

You can obtain CLI argument details through:

  1. Built-in help (run in terminal): 
    your_app --help    # Most Unix tools
your_app /?       # Common on Windows
  2. Official documentation:
    Check the application’s:
    • Official website
    • Source repository (e.g., GitHub README.md or man pages)

Why can’t I execute apps in the browser?

Browsers are designed to display web pages, not to execute arbitrary executable files like .exe. Use NW.js or HTA for full functionality.