@medyll/monorepo-vitrine
v1.1.1
Published
Sync monorepo packages to individual GitHub showcase repositories
Maintainers
Readme
monorepo-vitrine
A CLI that creates individual GitHub "showcase" repositories from packages in any monorepo (pnpm, yarn or npm workspaces). Each showcase repo mirrors the package README and selected files (CHANGELOG, LICENSE, etc.), making packages discoverable without exposing the full monorepo.
Features
- Works with pnpm (
pnpm-workspace.yaml), yarn and npm (workspacesinpackage.json) - Creates or updates a dedicated GitHub repository per package
- Syncs
README.md,CHANGELOG.md,LICENSE,SECURITY.md,CONTRIBUTING.md - Adds a banner linking back to the source monorepo
- Supports dry-run mode, orphan cleanup, and CI environments
Installation
Install at the root of your monorepo:
pnpm add -Dw @medyll/monorepo-vitrine
# or
yarn add -D @medyll/monorepo-vitrine
# or
npm install -D @medyll/monorepo-vitrineQuick start
Run the CLI from the root of your monorepo:
# Preview what would happen (no changes pushed)
monorepo-vitrine --dry-run --verboseUsage
monorepo-vitrine [options]Options
| Flag | Description |
|------|-------------|
| -d, --dry-run | Simulate changes without pushing to GitHub |
| -p, --allow-private | Include packages marked as private in their package.json |
| -c, --cleanup | Delete showcase repos that no longer match a workspace package |
| -v, --verbose | Print detailed logs and full error stacks |
| -s, --suffix [value] | Append a suffix to repo names. Without value: uses showcase. Omitted: no suffix |
Examples
# Dry-run with verbose output
monorepo-vitrine --dry-run --verbose
# Create showcase repos with default suffix (-showcase)
monorepo-vitrine --suffix
# Create showcase repos with a custom suffix
monorepo-vitrine --suffix=examples
# Include private packages and clean up orphans
monorepo-vitrine --allow-private --cleanupAuthentication
Set GITHUB_TOKEN in your environment with a token that has repo permissions on the target GitHub account.
export GITHUB_TOKEN=ghp_xxxxxxxxxxxxHow it works
Repository names are derived from the package name (scope removed). For example, @medyll/idae-socket becomes idae-socket, or idae-socket-showcase with --suffix.
License
MIT
Author: Lebrun Meddy (@medyll)
