CLI documentation

Below is the automatically generated docummentation for box. You can also find this by typing box --help in your terminal.

box

Automatic packaging and installers of your GUI with PyApp.

Usage:

box [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--version`	boolean	Show the version and exit.	`False`
`--help`	boolean	Show this message and exit.	`False`

clean

Clean the whole project.

By default, the dist, build, and target folders are deleted. The cleaner will ensure that you are in an initialized box project folder.

Usage:

box clean [OPTIONS]

Options:

Name	Type	Description	Default
`-d`, `--dist`	boolean	Flag to clean the `dist` folder where the python build lives.	`False`
`-b`, `--build`	boolean	Flag to clean the `build` folder where the pyapp build lives.	`False`
`-t`, `--target`	boolean	Flag to clean the `target` folder where the releases live.	`False`
`-s`, `--source-pyapp`	boolean	Flag to clean the `pyapp-source.tar.gz` file. If set, `-b`, `--build` flag is ignored.	`False`
`-p`, `--pyapp-folder`	boolean	Flag to clean the `pyapp` folder(s) in `build`. If set, `-b`, `--build` flag is ignored.	`False`
`--help`	boolean	Show this message and exit.	`False`

env

Manage the environmental variables.

All environmental variables will be set when packaging the app with PyApp. Therefore, if you want to set specific PYAPP_X variables, set them here.

Usage:

box env [OPTIONS]

Options:

Name	Type	Description	Default
`--get`	text	Get the value that is currently set to a variable.	None
`--list`	boolean	List all variables set.	`False`
`--set`	text	Set a `key=value` environmental variable pair with a string value.	None
`--set-bool`	text	Set a `key=value` environmental variable pair with a boolean. Valid boolean values are `0`, `1`, `True`, `False` (case insensitive).	None
`--set-int`	text	Set a `key=value` environmental variable pair with an integer value.	None
`--unset`	text	Unset variable with a given name.	None
`--help`	boolean	Show this message and exit.	`False`

init

Initialize a new project in the current folder.

Usage:

box init [OPTIONS]

Options:

Name	Type	Description	Default
`-q`, `--quiet`	boolean	Quiet mode: don't ask questions and initialize with default values.	`False`
`-b`, `--builder`	choice (`rye` \| `hatch` \| `pdm` \| `build` \| `flit` \| `custom`)	Set the builder for the project.	None
`--build-command`	text	If builder is set to `custom`, set the build command to specify how the project should be built.	None
`-opt`, `--optional-deps`	text	Set optional dependencies for the project.	None
`--gui`	boolean	Set the project as a GUI project. In quiet mode, this will default to `False`.	None
`-e`, `--entry`	text	Set the app entry for the project.	None
`-et`, `--entry-type`	choice (`spec` \| `module` \| `script` \| `notebook`)	Set the app entry type (X) to pass to PyApp (`PYAPP_ENTRY_X`) for the project.	None
`-py`, `--python-version`	choice (`pypy2.7` \| `pypy3.9` \| `pypy3.10` \| `3.7` \| `3.8` \| `3.9` \| `3.10` \| `3.11` \| `3.12`)	Set the python version to use with PyApp.	None
`--help`	boolean	Show this message and exit.	`False`

installer

Create an installer for the project.

Usage:

box installer [OPTIONS]

Options:

Name	Type	Description	Default
`-v`, `--verbose`	boolean	Flag to enable verbose mode.	`False`
`--help`	boolean	Show this message and exit.	`False`

package

Build the project, then package it with PyApp.

Note that if the pyapp source is already in the build directory, it will not be downloaded and/or extracted again. This speeds up the process if you are packaging multiple times. If you want to re-download it, please clean the project first with box clean.

Usage:

box package [OPTIONS]

Options:

Name	Type	Description	Default
`-v`, `--verbose`	boolean	Flag to enable verbose mode.	`False`
`-p`, `--pyapp-source`	text	Use local PyApp source code. Provide path to the folder or the .tar.gz archive.	None
`-pv`, `--pyapp-version`	text	Specify the PyApp version to use. See release page on PyApp GitHub.	`latest`
`--help`	boolean	Show this message and exit.	`False`

uninit

Uninitialize the project.

All references to box will be removed from the pyproject.toml file.

Usage:

box uninit [OPTIONS]

Options:

Name	Type	Description	Default
`-c`, `--clean-project`	boolean	Flag to clean the full project before uninitializing it.	`False`
`--help`	boolean	Show this message and exit.	`False`