Core supplies the CLI and standard site-authoring features. Optional packages add learning tools, application interfaces, authentication, and deployment support.
Use the packages you need and keep their release versions aligned.
The workshop tutorial uses Core for layouts, menus, themes, queries, and Markdown components, and explicitly adds Player for presentation.
| Package | Adds |
|---|---|
| @pathmx/email | Authored transactional email, capture previews, and durable Resend submission. |
| @pathmx/core | CLI, Sources, Blocks, links, rendering, and the standard Plugins. |
| @pathmx/generate | Generate Sources from Knap templates, JSON or CSV data, and saved recipes. |
| @pathmx/embed | X posts, YouTube players, and rich cards for public web pages. |
| @pathmx/player | Focus, Slides, and Player links. |
| @pathmx/share | CLI generation and preview of saved share images. Generation requires Bun and Chromium. |
| @pathmx/video | YouTube, Vimeo, Loom, and local video playback. |
| @pathmx/mermaid | Mermaid diagrams. |
| Package | Adds |
|---|---|
| @pathmx/graph | Local Source graphs and backlinks. |
| @pathmx/search | Search across content the reader can access. |
| @pathmx/webmcp | Browser agent tools for mounted interactions, with optional exposure controls. |
| @pathmx/ai | Named AI models, tool loops, images, usage metering and durable job outcomes. |
| @pathmx/agents | Agents authored as Markdown Actors, asking with their own permissions and replying in threads. |
| Package | Adds |
|---|---|
| @pathmx/completion | Requirement completion and progress. |
| @pathmx/auth | Authentication and account interfaces. |
| @pathmx/assessment | Markdown-authored assessment features. |
| @pathmx/uppy | Attachment uploads for Actors. |
| Package | Adds |
|---|---|
| @pathmx/react | React integration for application components. |
| @pathmx/ui | Shared React interface components. |
| @pathmx/short | Source-owned short links, redirect parameters, and CLI management. |
| @pathmx/feed | Full-text RSS feeds from authored queries. |
| @pathmx/analytics | Public page views, selected Events, and private realtime CLI reports. |
| @pathmx/deploy | Shared-Git server deployment, writable Source preservation, and failure reports. |
| @pathmx/cloudflare | Cloudflare publication support. |
@pathmx/react and @pathmx/ui are libraries: install them with bun add and
import them from your code. Feature Plugins and presets require activation.
Cloudflare and configured Completion compositions use the repository entrypoints
shown in their guides. Follow each package's exact setup.
Add a package to your project:
bun run pmx plugins add player
The command installs the dependency and activates it in your root package.json:
{
"pathmx": {
"plugins": { "@pathmx/player": {} }
}
}
Run bun run pmx plugins list to inspect installed packages and their activation status.
Commit package.json and the lockfile so collaborators use the same versions.
Each package key activates the package with its options. {} selects defaults.
Packages that declare configuration accept a JSON object in that entry. Invalid
options report the package and setting to fix. Adding a package preserves its
existing options. Removing its entry deactivates it without necessarily uninstalling
the dependency.
An explicitly activated package preset may replace a standard Core Plugin when its feature requires configured integration. Assessment uses this to replace the standard Input Plugin with its Assessment-aware Input configuration. A repository Plugin remains the final override layer.
Use repository Plugin files for custom behavior or programmatic composition. See Plugin configuration for defining configurable packages.
See CLI: Plugins for commands and options.