plone-client

What it does

• As a library, plone-client gives your code a client with one manager per plone.restapi service. Use it to sync content from an external source, to migrate content, or to automate site maintenance.
• As a command line client, plone-client manages any number of Plone sites, each one a named profile whose password stays in your operating system's keyring. It prints JSON and uses stable exit codes, so shell scripts and coding agents can use it as well as people.
• As an MCP server, plone-client mcp gives chat assistants the everyday reads and operations that take several requests, such as creating a page from Markdown or a news item with its images.

It works with Plone 6.0, 6.1, and 6.2, and needs Python 3.11 or later. See the compatibility grid for the plone.restapi versions.

Install

uv add plone-client                    # the library
uv tool install "plone-client[cli]"    # the command line
uv tool install "plone-client[mcp,markdown]"  # the MCP server, with Markdown pages

Use the library

from plone_client import PloneClient
from plone_client import blocks

with PloneClient("https://example.org", username="editor", password="secret") as client:
    page = client.content.create(
        "/news",
        "Document",
        title="Hello, Plone",
        **blocks.build(blocks.title(), blocks.description(), blocks.text("It works.")),
    )
    client.workflow.transition(page["@id"], "publish")

    for item in client.search.iter("/news", portal_type="Document", review_state="published"):
        print(item["@id"], item["title"])

Use the command line

plone-client profile add prod --url https://example.org --username editor --read-only
plone-client -p prod ls /news -f @id,title,review_state
plone-client -p prod search -t "News Item" --state published --limit 10

Documentation

The documentation is at https://plone.github.io/plone-client.

• Tutorials: your first script and your first command line session.
• How-to guides: sync content, manage profiles, upload files, use it from coding agents.
• Reference: compatibility, the client, managers, commands, configuration, and errors.
• Explanation: the design, secrets, and why a command line suits agents.

Contribute

• Issue tracker
• Source code
• Contributing guide

License

The project is licensed under the GPLv2. See LICENSE.GPL.