Skip to content

shopable-ai/shopme-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 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.

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

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors