Wagtail CLI
🚧 This is a prototype. Feedback very welcome! See Prototyping a new CLI for Wagtail for context.
Speed up and automate Wagtail operations with the command line. Key features:
- v3 write API client. 50+ CMS admin operations available from the terminal. To help manage local development and live sites. Manage pages, images, documents, snippets, sites, locales, redirects, and more.
- Read and search Wagtail docs as Markdown.
- Integrated agent skills with advanced progressive disclosure.
- Scaffold new Django/Wagtail projects.
Installation
Install wagtail-cli from PyPI with your preferred package manager, then use the wt CLI. Example with uv:
# Permanent install:
uv tool install wagtail-cli
# One-off usage:
uvx --from wagtail-cli wt
Optionally, install the one skill that helps agents with everything Wagtail. There are multiple options depending on your needs. To install directly as a skill, for multiple agents / harnesses:
# Directly with the CLI, global:
mkdir -p ~/.agents/skills/wagtail && wt skills get wagtail > ~/.agents/skills/wagtail/SKILL.md
# Directly with the CLI, local:
mkdir -p .agents/skills/wagtail && wt skills get wagtail > .agents/skills/wagtail/SKILL.md
It’s also available as a plugin, follow Agent Plugins compatible clients installation instructions, using this repository as the plugin source: wagtail/wagtail-cli.
Quick start
Docs access
Reading the Wagtail docs needs no configuration at all:
wt docs releases/8.0 # release notes, as Markdown
wt docs api # index of v3 API operations
wt docs search picture # search the docs
API usage
You will need to configure the needed API credentials before using the API commands:
export WAGTAIL_CLI_BASE_URL="https://cms.example.com/api/v3/"
export WAGTAIL_CLI_TOKEN="your-api-token"
wt api whoami # verify authentication
wt api pages list # browse pages
wt api schema list # discover page types
Create and publish a blog page from a Markdown file:
wt api pages create blog.BlogPage --parent /blog/ \
--title "Hello world" --field body:@post.md --publish
Rich-text fields accept Markdown via a .md file reference: the value is sent to the API as {"format": "db_markdown", "content": …}.
Command surface
wt api— the whole v3 API as commands:pages,images,documents,snippets,sites,locales,redirects,schema, pluswt api initandwt api whoami.wt docs— docs.wagtail.org as Markdown: release notes, the v3 API reference, and search.wt start— scaffold a new Django/Wagtail project (mirrorswagtail start/django-admin startproject, with a custom base page model as the default).- Delegation — any other
wt <command>is forwarded to./manage.py(if present) ordjango-admin(whenDJANGO_SETTINGS_MODULEis set), sowtalso fronts Django commands likewt runserverandwt makemigrations. wt --version/wt --help— enhanced with detected Wagtail/Django versions and./manage.py --helpwhen available.
Documentation
- Getting started — end-to-end walkthrough against the demo site.
- Command reference — every command and flag.
- Configuration — config cascade, dotfiles, environment variables.
- Agent skills — the machine-readable skill published for AI agents.
Contributing
See the development guide for details.
Metadata
Release files for wagtail-cli 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| wagtail_cli-0.4.0.tar.gz | 62.9 kB | Without provenance | Details for wagtail_cli-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| wagtail_cli-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for wagtail_cli-0.4.0-py3-none-any.whl |
Total release size: 149.2 kB
Release files / wagtail_cli-0.4.0.tar.gz
| Download URL | wagtail_cli-0.4.0.tar.gz |
|---|---|
| Size | 62.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c6cc6cb8b1b34f04c10bdf74638544182a432aa58c1c7e9ebec54e0bd47ea0fa
|
|
BLAKE2b-256 checksum How to use checksums |
fe5874e23a6fc05fc0856bd0f4ef85141b29454f1ab66747d7e53bf225f3ad4c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / wagtail_cli-0.4.0-py3-none-any.whl
| Download URL | wagtail_cli-0.4.0-py3-none-any.whl |
|---|---|
| Size | 86.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
11802f69ccf27fbb813b7355ec17730df5b15bee4d5b8c70eb4b79c73a9017aa
|
|
BLAKE2b-256 checksum How to use checksums |
cd53ee5a81aeb1d4e68b02153ec4df2f2f6e892455096437502e3fa95632c087
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for wagtail-cli 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.