pyodide CLI
Contents
pyodide CLI#
This page documents the Pyodide Command Line Interface (CLI) interface. In addition to the commands defined by pyodide-build, documented below, other subcommands are defined in external packages (which can be installed with pip):
pyodide pack, defined in pyodide-pack is a package bundler for Pyodide
pyodide#
A command line interface for Pyodide.
Other CLI subcommands are registered via the plugin system by installing Pyodide compatible packages (e.g. pyodide-build).
pyodide [OPTIONS] COMMAND [ARGS]...
Options
- --version#
auditwheel#
Auditwheel-like tool for emscripten wheels and shared libraries.
Registered by: auditwheel_emscripten
pyodide auditwheel [OPTIONS] COMMAND [ARGS]...
copy#
Copy shared libraries to the wheel directory. Similar to repair but does not modify the needed section of WASM module.
pyodide auditwheel copy [OPTIONS] WHEEL_FILE
Options
- --libdir <libdir>#
Path to the directory containing the shared libraries.
- Default
lib
- --output-dir <output_dir>#
Directory to output repaired wheel or shared library. (default: overwrite the input file)
Arguments
- WHEEL_FILE#
Required argument
exports#
Show exports of a wheel or a shared library file.
pyodide auditwheel exports [OPTIONS] WHEEL_OR_SO_FILE
Arguments
- WHEEL_OR_SO_FILE#
Required argument
imports#
Show imports of a wheel or a shared library file.
pyodide auditwheel imports [OPTIONS] WHEEL_OR_SO_FILE
Arguments
- WHEEL_OR_SO_FILE#
Required argument
repair#
[Experimental] Repair a wheel file: copy shared libraries to the wheel directory and modify the path in the wheel file.
pyodide auditwheel repair [OPTIONS] WHEEL_FILE
Options
- --libdir <libdir>#
Path to the directory containing the shared libraries.
- Default
lib
- --output-dir <output_dir>#
Directory to output repaired wheel or shared library. (default: overwrite the input file)
Arguments
- WHEEL_FILE#
Required argument
build#
Use pypa/build to build a Python package from source, pypi or url.
Registered by: pyodide-build
pyodide build [OPTIONS] [SOURCE_LOCATION]
Options
- --exports <exports>#
Which symbols should be exported when linking .so files?
- Default
requested
Arguments
- SOURCE_LOCATION#
Optional argument
build-recipes#
Build packages using yaml recipes and create repodata.json
Registered by: pyodide-build
pyodide build-recipes [OPTIONS] PACKAGES...
Options
- --recipe-dir <recipe_dir>#
The directory containing the recipe of packages. If not specified, the default is ./packages
- --install, --no-install#
If true, install the built packages into the install_dir. If false, build packages without installing.
- Default
False
- --install-dir <install_dir>#
Path to install built packages and repodata.json. If not specified, the default is ./dist.
- --cflags <cflags>#
Extra compiling flags. Default: SIDE_MODULE_CFLAGS
- --cxxflags <cxxflags>#
Extra compiling flags. Default: SIDE_MODULE_CXXFLAGS
- --ldflags <ldflags>#
Extra linking flags. Default: SIDE_MODULE_LDFLAGS
- --target-install-dir <target_install_dir>#
The path to the target Python installation. Default: TARGETINSTALLDIR
- --host-install-dir <host_install_dir>#
Directory for installing built host packages. Default: HOSTINSTALLDIR
- --log-dir <log_dir>#
Directory to place log files
- --force-rebuild, --no-force-rebuild#
Force rebuild of all packages regardless of whether they appear to have been updated
- Default
False
- --n-jobs <n_jobs>#
Number of packages to build in parallel
- Default
4
Arguments
- PACKAGES#
Required argument(s)
config#
Manage config variables used in pyodide
Registered by: pyodide-build
pyodide config [OPTIONS] COMMAND [ARGS]...
skeleton#
Add a new package build recipe or update an existing recipe
Registered by: pyodide-build
pyodide skeleton [OPTIONS] COMMAND [ARGS]...
pypi#
Create a new package from PyPI.
pyodide skeleton pypi [OPTIONS] NAME
Options
- -u, --update#
Update an existing recipe instead of creating a new one
- Default
False
- --update-patched#
Force update the package even if it contains patches.
- Default
False
- --version <version>#
The version of the package, if not specified, latest version will be used.
- --source-format <source_format>#
Which source format is preferred. Options are wheel or sdist. If not specified, then either a wheel or an sdist will be used.
- --root <root>#
The root directory of the Pyodide.
- --recipe-dir <recipe_dir>#
The directory containing the recipe of packages.If not specified, the default is packages in the root directory.
Arguments
- NAME#
Required argument
Environment variables
- PYODIDE_ROOT
Provide a default for
--root