Install plone-client

Install plone-client#

This guide shows you how to install plone-client, as a library for your own code, as a command line tool, or both. plone-client needs Python 3.11 or later.

Use it as a library#

Add it to your project’s dependencies. The library needs only httpx.

uv

uv add plone-client

pip

pip install plone-client

Use the command line#

Install it as a tool, with the cli extra, which adds typer, keyring, and tomlkit.

uv

uv tool install "plone-client[cli]"

pipx

pipx install "plone-client[cli]"

Check that it works.

plone-client --version

To complete commands in your shell, run plone-client --install-completion.

Add the optional features#

Two more extras add optional features.

Extra	Adds	Needs
`markdown`	Pages from Markdown or HTML, converted to blocks by `collective.html2blocks`.	Python 3.12 or later; on 3.11 it installs nothing.
`mcp`	The MCP server, `plone-client mcp`, with the command line it runs in.

Combine extras as you need them.

uv tool install "plone-client[mcp,markdown]"

Use both#

If your code reads the profiles of the command line with from_profile(), add the extra to your project’s dependencies too.

uv add "plone-client[cli]"

Next steps#

Connect to a site connects your code to a site.
Manage profiles adds your sites as profiles.
Compatibility lists the Plone versions that work.