Cheat sheet#

The commands of plone-client by task. Each name links to its options in Command line. <ref> is a path, a URL inside the site, uid:<UID>, or a resolveuid link.

Connect#

Task

Command

Reference

Add a site

plone-client profile add prod --url https://example.org --username admin --use

profile add

Add a read-only site

plone-client profile add prod --url https://example.org --username admin --read-only

profile add

List the sites

plone-client profile list

profile list

Switch sites

plone-client profile use staging

profile use

One command on another site

plone-client -p staging ls /

Global options

See who you are

plone-client info

info

Inspect#

Task

Command

Reference

Print an item

plone-client get /news/item

get

List a folder

plone-client ls /news -f @id,title,review_state

ls

Summarize the blocks of an item

plone-client blocks /news/item

blocks

Find an item by UID

plone-client resolve uid:<UID>

resolve

Show the history

plone-client history /news/item

history

Show who has access

plone-client sharing /news/item

sharing

List the content types

plone-client types

types

Show the fields of a type

plone-client types "News Item"

types

List the blocks of the site

plone-client block-types

block-types

List the terms of a vocabulary

plone-client vocabulary plone.app.vocabularies.Keywords

vocabulary

Create and update#

Task

Command

Reference

Create an item

plone-client create /news "News Item" --title "Title"

create

Create a page from Markdown

plone-client create-page /docs page.md

create-page

Create an item with files

plone-client create-with-files /news "News Item" lead.jpg --title "Title"

create-with-files

Change fields

plone-client update /news/item --title "New title"

update

Set a list field

plone-client update /news/item -s subjects:='["plone"]'

update

Delete an item

plone-client delete /news/old

delete

Publish#

Task

Command

Reference

Show the state and transitions

plone-client workflow /news/item

workflow

Publish an item

plone-client workflow /news/item publish

workflow

Publish a folder and its contents

plone-client workflow /news publish --recursive

workflow

Create and publish at once

plone-client create /news "News Item" --title "Title" --publish publish

create

Move#

Task

Command

Reference

Move an item

plone-client move /news/old --to /archive

move

Copy an item

plone-client copy /news/item --to /archive

copy

Put an item first in its folder

plone-client order /news item top

order

Redirect an old path

plone-client aliases add /news/item /old-path

aliases add

Upload and download#

Task

Command

Reference

Upload files

plone-client upload /media photo.jpg report.pdf

upload

Upload a large file in chunks

plone-client upload /media video.mp4 --tus

upload

Upload a folder as pages

plone-client upload-tree ./handbook /docs --pages

upload-tree

Download a file

plone-client download /media/report.pdf -o report.pdf

download

Users and settings#

Task

Command

Reference

List users

plone-client users list -f id,email

users list

Create a user

plone-client users create jdoe --email jdoe@example.org

users create

Add a user to a group

plone-client groups add-member editors jdoe

groups add-member

Read a setting

plone-client registry get plone.site_title

registry get

Change a setting

plone-client registry set plone.site_title '"New title"'

registry set

Protect a site#

Task

Command

Reference

Preview a change

plone-client -n delete /news/old

Preview changes and protect a site

Refuse every change

plone-client --read-only update /news/item --title "Title"

Preview changes and protect a site

Confirm in advance

plone-client delete /news/old --yes

Confirmation

Automate#

Task

Command

Reference

Keep only some keys

plone-client ls /news -f @id,title

Output

Print JSON on one line

plone-client ls /news -c

Output

Log each request

plone-client -v get /

Global options

Send any request

plone-client request GET /@navroot

request

Serve a site to an assistant

plone-client mcp

mcp

Give the skill to a coding agent

plone-client skill install

skill install