How-to guides#

Solve a specific problem with plone-client.

Set up#

๐Ÿ“ฆ Install plone-client

Install the library, the command line, and the optional extras.

Install plone-client
๐Ÿ”Œ Connect to a site

Authenticate a client, from code or from the environment.

Connect to a site
๐Ÿ—‚๏ธ Manage profiles

Name your sites, and keep their secrets out of files.

Manage profiles
๐Ÿณ Run a Plone site for testing

A throwaway site with Volto and sample content.

Run a Plone site for testing

Work with content#

๐Ÿ”„ Sync content

Keep a site in step with an external source.

Sync content from an external source
โšก Create content in one step

Pages from Markdown, items with files, folders of documents.

Create content in one step
๐Ÿ“ฐ Publish a news item

From a draft to a published item with a lead image.

Publish a news item with a lead image
๐Ÿงฑ Build any block

Write Volto blocks, including grids and add-on blocks.

Build any block
๐Ÿ“Ž Upload files

Store files and images, large ones included.

Upload and download files
๐Ÿ‘€ Preview changes

See what would change before it does.

Preview changes and protect a site
๐Ÿšจ Handle errors

React to what a site answers.

Handle errors
๐Ÿงฐ Call other services

Reach services that have no manager.

Call other services
๐Ÿ˜ Work with large sites

Batching, metadata fields, and the cost of each call.

Work with large sites
๐Ÿ‘ฅ Manage users and sharing

Users, groups, and who can see what.

Manage users and sharing

Automate#

๐Ÿงน Everyday site management

Recipes for common jobs from the terminal.

Everyday site management
โš™๏ธ Use the command line in scripts and CI

No keyring, no terminal, no prompts.

Use the command line in scripts and CI
โ™ป๏ธ Replace a hand-written client

Move a project off its own REST calls.

Replace a hand-written client

Assistants and agents#

๐Ÿง‘โ€๐Ÿ’ป Use with coding agents

Give an agent the skill and the command line.

Use plone-client with coding agents
๐Ÿ’ฌ Connect an assistant

Serve a site to an MCP client.

Connect an assistant through the MCP server
๐Ÿ–ฅ๏ธ Connect Claude Desktop

Set up the desktop application, step by step.

Connect Claude Desktop to a Plone site
๐Ÿ›ก๏ธ Protect a site from an agent

Decide what an assistant can see and do.

Protect a site from an agent
๐Ÿฆพ Build a custom agent

A Python program with human approval.

Build a custom agent

When something goes wrong#

๐Ÿฉบ Troubleshoot

Find the cause from the symptom.

Troubleshoot