Skip to main content

Use this module to convert a cli program to a gui

Project description

Github top language Codacy grade Repository size Issues License Commit activity Last commit PyPI Downloads PyPI Version


Project Icon

Use this module to convert a CLI program to a GUI

Comparison to similar projects

Do let me know if any of these are incorrect. Some of the comparisons are based off documentation/ the readme

Parser Support

Parser Cli2Gui Gooey Quick
Argparse :heavy_check_mark: :heavy_check_mark: X
Optparse :heavy_check_mark: X X
DocOpt :heavy_check_mark: X X
Click :heavy_check_mark: * X :heavy_check_mark:
GetOpt :heavy_check_mark: X X
* Partial support (use Click2Gui)

This works for simpler programs but sadly falls flat for more complex programs

GUI Toolkit Support

GUI Toolkits Cli2Gui Gooey Quick
Tkinter :heavy_check_mark: X X
WxWidgets X :heavy_check_mark: X
Qt :heavy_check_mark: X :heavy_check_mark:
Gtk X X X
Web :heavy_check_mark: X X

GUI Feature Support

Basic GUI Cli2Gui Gooey Quick
Override name/ description :heavy_check_mark: :heavy_check_mark: ?
Theming :heavy_check_mark: Limited ?
DarkMode :heavy_check_mark: X :heavy_check_mark:
Window Size :heavy_check_mark: :heavy_check_mark: X
Element Size :heavy_check_mark: X X
Custom Images :heavy_check_mark: :heavy_check_mark: ?

Cli2Gui is pretty lacking in these features and will probably remain that way to ease maintainability - the primary aim is to support multiple argparse libraries over fancy widgets

Advanced GUI Cli2Gui Gooey Quick
Dropdown :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
Slider X :heavy_check_mark: :heavy_check_mark:
Tabs X :heavy_check_mark: :heavy_check_mark:
Menus :heavy_check_mark: :heavy_check_mark: X
Max Args before Scroll :heavy_check_mark: X X


For completed components, see the changelog (link below)

Feature Description Status
Python Fire Under consideration


See the CHANGELOG for more information.


@Cli2Gui(run_function, auto_enable=False, parser="argparse", gui="pysimplegui",
		theme=None, darkTheme=None, sizes=None, image=None, program_name=None,
		program_description=None, max_args_shown=5, **kwargs)

Using the decorator in your project

run_function (optional)

The name of the function to call eg. main(args). Defaults to None. If not specified, program continues as normal (can only run once)

def main(args):

def cli():
	parser = argparse.ArgumentParser(description="this is an example parser")
	parser.add_argument("arg", type=str,
		help="positional arg")
	args = parser.parse_args()

auto_enable (optional)

Enable the GUI by default. If enabled by default requires --disable-cli2gui, otherwise requires --cli2gui


parser (optional)

Override the parser to use, defaults to argparse. Current options are: "argparse", "getopt", "optparse", "docopt"


gui (optional)

Override the gui to use. Current options are: "pysimplegui", "pysimpleguiqt","pysimpleguiweb". Defaults to "pysimplegui".

pysimplegui is the recommended option


theme (optional)

Set a base24 theme. Can also pass a base24 scheme file. eg. one-light.yaml

@Cli2Gui(theme=["#e7e7e9", "#dfdfe1", "#cacace", "#a0a1a7", "#696c77",
		"#383a42", "#202227", "#090a0b", "#ca1243", "#c18401", "#febb2a",
		"#50a14f", "#0184bc", "#4078f2", "#a626a4", "#986801", "#f0f0f1",
		"#fafafa", "#ec2258", "#f4a701", "#6db76c", "#01a7ef", "#709af5",

darkTheme (optional)

Set a base24 dark theme variant. Can also pass a base24 scheme file. eg. one-dark.yaml

@Cli2Gui(darkTheme=["#282c34", "#3f4451", "#4f5666", "#545862", "#9196a1",
		"#abb2bf", "#e6e6e6", "#ffffff", "#e06c75", "#d19a66", "#e5c07b",
		"#98c379", "#56b6c2", "#61afef", "#c678dd", "#be5046", "#21252b",
		"#181a1f", "#ff7b86", "#efb074", "#b1e18b", "#63d4e0", "#67cdff",

sizes (optional)

Set the UI sizes such as the button size

		"title_size": 28,
		"label_size": (30, None),
		"input_size": (30, 1),
		"button":(10, 1),
		"padding":(5, 10),
		"helpText_size": 14,
		"text_size": 11})

image (optional)

Set the program icon. File extensions can be any that PIL supports


program_name (optional)

Override the program name

@Cli2Gui(program_name="custom name")

program_description (optional)

Override the program description

@Cli2Gui(program_description="this is a custom description")

max_args_shown (optional)

Maximum number of args shown before using a scrollbar


menu (optional)

Add a menu to the program. Defaults to None. eg.

THIS_DIR = str(Path(__file__).resolve().parent)
menu={"File": THIS_DIR + "/"}

Works significantly better with pysimplegui than pysimpleguiqt

@Cli2Gui(menu={"File": THIS_DIR + "/", "Another File": THIS_DIR + "/", })


def Click2Gui(run_function, gui="pysimplegui", theme=None, darkTheme=None,
		sizes=None, image=None, program_name=None, program_description=None,
		max_args_shown=5, menu=None, **kwargs):

Very similar to the decorator but with the following differences...

run_function (required)

Specify the click function to use. (attempts were made to offer full program support however this behaved very poorly)

parser (not applicable)

As this is exclusively for click, this option is not present

Data Structures

See the DATA_STRUCTURES for more information.

Install With PIP

pip install cli2gui

Head to for more info

Language information

Built for

This program has been written for Python 3 and has been tested with Python version 3.8.0

Install Python on Windows


choco install python


To install Python, go to and download the latest version.

Install Python on Linux


sudo apt install python3.8

How to run

With VSCode

  1. Open the .py file in vscode
  2. Ensure a python 3.8 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.8)
  3. Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)

From the Terminal




Using The Command Line

  1. Press the Clone or download button in the top right
  2. Copy the URL (link)
  3. Open the command line and change directory to where you wish to clone to
  4. Type 'git clone' followed by URL in step 2
$ git clone

More information can be found at

Using GitHub Desktop

  1. Press the Clone or download button in the top right
  2. Click open in desktop
  3. Choose the path for where you want and click Clone

More information can be found at

Download Zip File

  1. Download this GitHub repository
  2. Extract the zip archive
  3. Copy/ move to the desired location


MIT License (See the LICENSE for more information.)



Screenshot 1 Screenshot 2 Screenshot 3


Light Dark Black
Theme 1 Theme 2 Theme 3

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cli2gui, version 2020.6
Filename, size File type Python version Upload date Hashes
Filename, size cli2gui-2020.6-py3-none-any.whl (23.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cli2gui-2020.6.tar.gz (23.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page