Plone CLIはPloneパッケージを作成

Plone CLI は、Plone パッケージの開発を目的としています。 コピー機テンプレートを使用して、Plone バックエンドアドオン、Zope プロジェクト設定をスキャフォールドし、コンテンツタイプ、動作、REST API サービスなどの機能を追加します。

互換性

バージョン 7.x 以降では、 bobtemplate ではなく、コピアーテンプレートを使用します。 plone または Cookiecutter テンプレート。 これは、いくつかのUXの利点とテンプレートへの柔軟性をもたらし、将来性を証明しています。

• バージョン >= 7.x は、ビルドアウトの代わりに、新しいコピアーテンプレート(UV/pyproject.toml)を使用し、Plone >= 6.x をサポートします。
• バージョン == 3.x ** (現在の安定したバージョン)** bobtemplates を使用します。 plone といくつかの cookieplone テンプレートと Plone >= 6.x もサポートします。
• Plone 5.x と Python 3 用の bobtemplates.plone を使用する場合は、bbtemplates と一緒に plonecli を使うことができます。 plone == 6.x. Plone 5 と Plone 6 をサポートしているのは、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