Install¶
TL;DR: Get Started Real Fast¶
uv tool install pulp-cli[pygments]
pulp config create -e
# insert your server configuration here
pulp status
pip install pulp-cli[pygments]
pulp config create -e
# insert your server configuration here
pulp status
pipx install pulp-cli[pygments]
pulp config create -e
# insert your server configuration here
pulp status
The pulp-cli package can be installed from a variety of sources. After installing, see the next section on how to configure pulp-cli.
Using uv¶
To install with uv run:
uv tool install pulp-cli
uv tool install pulp-cli[pygments,shell]
Additional plugins need to be specified at install time like this:
uv tool install --with pulp-cli-deb pulp-cli
Using pipx¶
Warning
When using additional plugins, this approach does not enforce known good version combinations of pulp-cli and the plugin.
To install with pipx run:
pipx install pulp-cli
You can add optional dependencies in the usual way.
pipx install pulp-cli[pygments,shell]
Additional plugins need to be injected into the apps virtual environment like this:
pipx inject pulp-cli pulp-cli-deb
From PyPI using pip¶
Warning
We highly recommend using virtual environments with pip.
To install with minimal dependencies:
pip install pulp-cli # minimal dependencies
You can also include optional dependencies for advanced features with one of the following commands:
pip install pulp-cli[pygments] # colorized output
pip install pulp-cli[shell] # with interactive shell mode
If you want to install additional cli plugins, you can follow this example:
pip install pulp-cli-deb
From a source checkout¶
If you intend to use unreleased features, or want to contribute to the CLI, you can install from source:
# Upon entering the source directory, uv handles the virtual environment on the fly.
git clone git@github.com:pulp/pulp-cli.git
cd pulp-cli
uv run pulp status
# Alternatively run in plugin development:
git clone git@github.com:pulp/pulp-cli-gem.git
cd pulp-cli-gem
uv run pulp status
# The matching glue development version is automatically taken from the same workspace.
git clone git@github.com:pulp/pulp-cli.git
uv tool install --editable pulp-cli
# Alternatively install plugins from source:
git clone git@github.com:pulp/pulp-cli-gem.git
uv tool install pulp-cli --with-editable pulp-cli-gem
# The matching glue development version must be installed from the same source.
git clone git@github.com:pulp/pulp-cli.git
pip install -e ./pulp-cli -e ./pulp-cli/pulp-glue
# Alternatively install plugins from source:
git clone git@github.com:pulp/pulp-cli-deb.git
pip install -e ./pulp-cli-deb
git clone git@github.com:pulp/pulp-cli-maven.git
pip install -e ./pulp-cli-maven -e ./pulp-cli-maven/pulp-glue-maven