Skip to main content

wp-tui

A text-based terminal UI for interacting with a self-hosted WordPress site — create and edit posts and pages, work with the native block editor, format text with markdown-style shortcuts that map to WordPress's real inline formats, upload or pick images from the media library, and edit post settings (status, slug, excerpt, categories/tags, featured image). Mouse navigation throughout, with an optional Vim-style key layer.

Requirements

  • Python 3.12 or newer
  • A self-hosted WordPress site with the REST API enabled, and an Application Password (WordPress Admin → Users → Profile → Application Passwords). The site must be served over HTTPS — wp-tui refuses to send credentials over plaintext http://.

Installation

The recommended install is with pipx (isolated, cross-platform):

pipx install wptui
wptui

A Homebrew tap is planned:

# once the tap is published
brew install gboone/tap/wptui

You'll be prompted for your site URL, username, and Application Password. The password is stored in your OS keychain via keyring; only non-secret profile data is written to the config file.

Known limitation — headless/SSH

keyring needs an OS secret backend (macOS Keychain, Linux Secret Service, Windows Credential Locker). On a headless machine reached over SSH with no Secret Service running, credential storage will fail, so wp-tui cannot save or load the Application Password there. This affects any install method; it is a runtime environment limitation, not a packaging one.

From source (development)

python3 -m venv .venv
. .venv/bin/activate
pip install -e ".[dev]"
python -m wptui

For UI debugging, run textual console in another terminal and launch with textual run --dev wptui.app:WPTuiApp.

Test

pytest

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wptui-0.1.4.tar.gz (131.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wptui-0.1.4-py3-none-any.whl (101.4 kB view details)

Uploaded Python 3

File details

Details for the file wptui-0.1.4.tar.gz.

File metadata

  • Download URL: wptui-0.1.4.tar.gz
  • Upload date:
  • Size: 131.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for wptui-0.1.4.tar.gz
Algorithm Hash digest
SHA256 7658dbf06020cc743a84abc70b2ae04ec28e0227498e8317dd3908d277fa2c3d
MD5 1bd6e790de4769adb577d1d6914365ec
BLAKE2b-256 4e6124b7d7dfbe1583df9c7acc69c8ca9e28c398a78c2c83033340ed07f2008b

See more details on using hashes here.

File details

Details for the file wptui-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: wptui-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 101.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for wptui-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4eeca5a261e7a7661c92660497f505e12f12458c191deecb9915014d93408ec1
MD5 0e95be3a90aa4f6e2f92436e6d6e48d0
BLAKE2b-256 39dd130e078ec71972195fc0d2fe63b6c8a157f0df67cbf21fb0970a31f9e641

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page