Plone Package 생성을 위한 Plone CLI

Plone CLI는 Plone 패키지를 개발하는 것을 의미한다. 그것은 비계 Plone 백엔드 애드온, Zope 프로젝트 설정에 복사기 템플릿을 사용하고 내용 유형, 행동 및 REST API 서비스와 같은 기능을 추가합니다.

호환성

버전 7.x에서 시작, 우리는 bobtemplates 대신 복사기 템플릿을 사용합니다. plone 또는 Cookiescutter 템플릿. 이 템플릿에 대한 몇 가지 UX 장점과 유연성을 가져오고 미래의 증거입니다.

• 버전 >= 7.x는 새로운 복사기 템플렛 (UV/pyproject.toml 대신 buildout)를 사용하고 Plone >= 6.x를 지원합니다.
• 버전 == 3.x (현재 안정 버전) 사용 bobtemplates. plone와 몇몇 Cookiesplone 템플렛은 또한 Plone >= 6.x를 지원합니다.
• Plone 5.x 및 Python 3 용 bobtemplates.plone을 사용하면 bobtemplates와 함께 plonecli를 사용할 수 있습니다. 파일 형식 그들은 Plone 5와 Plone 6를 지원한다. Plone 5.x를 위한 그(것)들을 만들 필요가 있는 경우에, bobtemplates.plone (the open-standard discovery path) and linked from]~/.claude/skills/ for Claude Code. Use—scope 프로젝트를 대신에 설치하기 위하여 사용하십시오.

Plone CLI

A Plone CLI for creating Plone packages

The Plone CLI is meant for developing Plone packages. It uses copier templates to scaffold Plone backend addons, Zope project setups, and add features like content types, behaviors, and REST API services.

Compatibility

Starting from version 7.x, we use copier templates instead of bobtemplates.plone or cookiecutter templates. This brings some UX advantages and flexibility to the templates and is future-proof.

• Versions >= 7.x use the new copier templates (UV/pyproject.toml instead of buildout) and support Plone >= 6.x.
• Versions == 3.x (current stable version) use bobtemplates.plone and some cookieplone templates and also support Plone >= 6.x.
  • When using bobtemplates.plone for Plone 5.x and Python 3, you can use plonecli together with bobtemplates.plone == 6.x. They support Plone 5 and Plone 6, except for the theming templates, which are made for Plone 6. If you really need to create a theming package for Plone 5.x, use bobtemplates.plone < 6.x.

Installation

UV Tool (Recommended)

The recommended way to install plonecli is as a UV tool, which makes it available globally:

uv tool install plonecli

To upgrade:

uv tool upgrade plonecli

Run Without Installing (uvx)

You can run plonecli without installing it using uvx:

uvx plonecli create addon my.addon

In a Virtual Environment

uv venv
source .venv/bin/activate
uv pip install plonecli

With pipx

pipx install plonecli

Shell Completion

plonecli supports tab-completion for commands and template names in bash, zsh, and fish.

Quick Install

plonecli completion --install

This auto-detects your shell and appends the activation line to your ~/.bashrc, ~/.zshrc, or fish completions directory. Restart your shell afterward.

Manual Setup

If you prefer to set it up yourself:

Bash (add to ~/.bashrc):

eval "$(_PLONECLI_COMPLETE=bash_source plonecli)"

Zsh (add to ~/.zshrc):

eval "$(_PLONECLI_COMPLETE=zsh_source plonecli)"

Fish (add to ~/.config/fish/completions/plonecli.fish):

env _PLONECLI_COMPLETE=fish_source plonecli | source

Faster Startup (Optional)

The eval approach generates the completion script on every shell start. For faster startup, save it to a file:

# Generate once
_PLONECLI_COMPLETE=bash_source plonecli > ~/.plonecli-complete.bash

# Then source from your ~/.bashrc instead of eval
source ~/.plonecli-complete.bash