README.md

fmr

English ｜ 中文

A CLI that lets you experience modern monorepo project quickly and easily, powered by turborepo, pnpm and changesets.

Features:

• Create a monorepo template project
• Use pnpm as a package manager
• Use turborepo to preform multiple package script tasks

Install

Install it globally:

pnpm add fmr -g
# Or Yarn
yarn add fmr -g
# Or npm
npm i fmr -g

Command

Overview:

• fmr new
• fmr add
• fmr run
• fmr publish
• fmr version

fmr new

Usage:

fmr new <project>

Create a new monorepo project

Command options:

  --type ts       monorepo with typescript
  --type js       monorepo with javascript

fmr add

Usage:

fmr add <package>

Command options:

  --scope <name>  install package in scope
  --save-dev
  -S
  --dev
  -D

Note that if you don't set --scope, the package will be installed in root.

fmr run

Usage:

fmr run <command>

fmr changeset

Usage:

fmr changeset

fmr version

Usage:

fmr version

fmr publish

Usage:

fmr publish

Note that if you want to publish to a private registry, you should add publicConfig.registry to packagejson of the published package, for example:

{
  ...
  "publicConfig": {
    "registry": "http://localhost:4873"
  }
}