Mingcute CLI

Command line tools for Mingcute Pro. Use it to activate your Mingcute Pro license key and configure access to the private npm registry.

Published on npm:

https://www.npmjs.com/package/@mingcute/cli

Login

npx @mingcute/cli login

The command verifies your Mingcute Pro license key with api.mingcute.com, receives a private npm registry token, and writes the npm configuration needed to install @mingcute-pro/* packages.

Default target:

~/.npmrc

Project-local target:

npx @mingcute/cli login --project

Pro Styles

Mingcute Pro includes 12 icon styles:

| Style | React package | Vue package | SVG package | Component suffix | | --- | --- | --- | --- | --- | | Light | @mingcute-pro/react-light | @mingcute-pro/vue-light | @mingcute-pro/svg-light | Light | | Regular | @mingcute-pro/react-regular | @mingcute-pro/vue-regular | @mingcute-pro/svg-regular | Regular | | Filled | @mingcute-pro/react-filled | @mingcute-pro/vue-filled | @mingcute-pro/svg-filled | Filled | | Duotone | @mingcute-pro/react-duotone | @mingcute-pro/vue-duotone | @mingcute-pro/svg-duotone | Duotone | | Two Tone | @mingcute-pro/react-two-tone | @mingcute-pro/vue-two-tone | @mingcute-pro/svg-two-tone | TwoTone | | Cute Light | @mingcute-pro/react-cute-light | @mingcute-pro/vue-cute-light | @mingcute-pro/svg-cute-light | CuteLight | | Cute Regular | @mingcute-pro/react-cute-regular | @mingcute-pro/vue-cute-regular | @mingcute-pro/svg-cute-regular | CuteRegular | | Cute Filled | @mingcute-pro/react-cute-filled | @mingcute-pro/vue-cute-filled | @mingcute-pro/svg-cute-filled | CuteFilled | | Cute Duotone | @mingcute-pro/react-cute-duotone | @mingcute-pro/vue-cute-duotone | @mingcute-pro/svg-cute-duotone | CuteDuotone | | Sharp | @mingcute-pro/react-sharp | @mingcute-pro/vue-sharp | @mingcute-pro/svg-sharp | Sharp | | Sharp Regular | @mingcute-pro/react-sharp-regular | @mingcute-pro/vue-sharp-regular | @mingcute-pro/svg-sharp-regular | SharpRegular | | Sharp Filled | @mingcute-pro/react-sharp-filled | @mingcute-pro/vue-sharp-filled | @mingcute-pro/svg-sharp-filled | SharpFilled |

Install Pro Packages

After login, install the style package you need:

pnpm add @mingcute-pro/react-regular

npm install @mingcute-pro/react-regular

Vue and raw SVG packages use the same style names:

pnpm add @mingcute-pro/vue-regular
pnpm add @mingcute-pro/svg-regular

React Usage

Import icons from the package entry:

import { Home1Regular, Search2Regular } from '@mingcute-pro/react-regular';

export function App() {
  return (
    <div>
      <Home1Regular size={24} color="currentColor" />
      <Search2Regular size={24} color="#111827" />
    </div>
  );
}

Direct icon imports are also supported:

import Home1Regular from '@mingcute-pro/react-regular/icons/home-1';

export function HomeButton() {
  return <Home1Regular size={20} color="currentColor" />;
}

Different styles use different package names and component suffixes:

import { Home1Filled } from '@mingcute-pro/react-filled';
import { Home1TwoTone } from '@mingcute-pro/react-two-tone';
import { Home1CuteFilled } from '@mingcute-pro/react-cute-filled';
import { Home1SharpRegular } from '@mingcute-pro/react-sharp-regular';

All React icons accept common SVG props plus size and color.

import { ArrowRightRegular } from '@mingcute-pro/react-regular';

export function NextLink() {
  return (
    <a href="/next">
      Next
      <ArrowRightRegular size={18} aria-hidden="true" />
    </a>
  );
}

Commands

mingcute login
mingcute whoami
mingcute npmrc
mingcute logout

Check the current registry token:

npx @mingcute/cli whoami

Print the npm configuration block:

npx @mingcute/cli npmrc

Remove the Mingcute Pro npm configuration block:

npx @mingcute/cli logout