@thebeyondgroup/shopwatch
v0.5.0
Published
Shopwatch CLI
Keywords
Readme
Shopwatch CLI & MCP Server
A TypeScript CLI and MCP server for querying Shopwatch from the terminal or Claude.
- CLI:
shopwatch log,shopwatch resources,shopwatch lenses, etc. - MCP Server: Connects Claude (Code or Desktop) to Shopwatch -- see MCP Setup
Development
mise tasks work from anywhere in the repo.
mise build:cli # Compile TypeScript
mise test:cli # Run tests
mise lint:cli # Type check
mise run:cli -- log # Build + run locallyConfiguration
The CLI uses environment variables only -- no config file, no auth commands.
| Variable | Description |
|----------|-------------|
| SHOPWATCH_API_URL | Shopwatch instance URL (e.g. http://localhost:4000) |
| SHOPWATCH_API_KEY | API key (starts with sw_key_) |
Releasing
See CLI Release Process for the full workflow. In short:
mise release:cli patch # Cut a release PR (patch/minor/major or explicit version)
# After PR merges:
mise release:cli:tag 0.5.0 # Tag + trigger CI pipelineDirectory Structure
cli/
├── src/
│ ├── commands/ # oclif command definitions
│ ├── mcp/ # MCP server implementation
│ └── ...
├── bin/ # Entry points (run.js, bun-run.ts)
├── test/ # Tests (vitest)
└── package.json # Version source of truth