ShopMe CLI

ShopMe is an open-source CLI by Shopable for turning personal knowledge, work, services, and bookable time into an AI-readable commercial website.

It starts from Markdown, MDX, and docs.config.yml, then gives you a local preview, static export, publish shortcut, and AI editing sidecars that help assistants understand where content belongs.

Install

npm install -g shopme

Quick Start

shopme init site my-site --title "My Work"
cd my-site
shopme

The default command starts the local embedded website runtime. Use shopme build when you want a static HTML export.

shopme -p 9000 -w
shopme build . --out dist
shopme mount check dist/html --base-path / --canonical https://example.com

AI Editing

ShopMe creates .shopme/rules.md, .shopme/rules.json, .shopme/link-index.json, and .shopme/project-map.md so local AI tools can understand the site's content rules before editing.

Public content visibility is controlled by .docsignore at the project root. Dot-prefixed and underscore-prefixed paths are hidden by default; publish a small dot-prefixed content path only by allowing both the directory and the file:

!.prompts/
!.prompts/public.md

System/private paths such as .git/, .shopme/, .next/, build/, dist/, and node_modules/ remain private even if a later ! rule matches them.

For direct document editing, use the local HTTP API exposed by the embedded runtime:

• Resolve before writing: POST /api/docs/v1/documents:resolve
• Save with concurrency protection: PUT /api/docs/v1/documents/:documentId
• MCP adapter: shopme-mcp

Package

• npm package: shopme
• CLI command: shopme
• repository: shopable-ai/shopme-cli
• brand family: Shopable

License

MIT