Boxicons CLI

Interactive CLI tool for installing Boxicons packages.

Installation

npm install -g boxicons-cli
# or
npx boxicons-cli

Usage Flow

Step 1: Select Plan

? Select your Boxicons Plan: (Use arrow keys)
❯ FREE
  PRO

If FREE is selected:

Step 2: Select Framework

? Select the framework/package to install: (Use arrow keys)
❯ JavaScript
  React
  Vue
  Svelte
  Core

Installs the corresponding free package and exits.

If PRO is selected:

Step 2: Enter API Key

? Enter your Boxicons Pro API Key: [hidden]

Creates/updates .npmrc file with:

@boxicons-pro:registry=https://npm.boxicons.com/
//npm.boxicons.com/:_authToken=YOUR_API_KEY

Step 3: Select Installation Type

? Select installation type: (Use arrow keys)
❯ Individual Packages (Recommended)
  Main Package

If Main Package is selected:

Step 4: Select Framework

? Select framework: (Use arrow keys)
❯ JS
  React
  Vue
  Svelte

Installs: @boxicons-pro/{framework}

If Individual Packages is selected:

Step 4: Select Framework

? Select framework: (Use arrow keys)
❯ JS
  React
  Vue
  Svelte

Step 5: Select Pack

? Select icon pack: (Use arrow keys)
❯ basic
  filled
  brands
  duotone
  duotone-mix
  duotone-solid

If pack is NOT brands:

Step 6: Select Style

? Select style: (Use arrow keys)
❯ regular
  rounded
  sharp

Step 7: Select Weight

? Select weight: (Use arrow keys)
❯ thin
  normal
  bold

Installs: @boxicons-pro/{framework}-{pack}-{style}[-{weight}] (Weight is omitted if 'normal' is selected)

If pack IS brands:

Skips style and weight selection.

Installs: @boxicons-pro/{framework}-brands

Examples

FREE - Install React

? Select your Boxicons Plan: FREE
? Select the framework/package to install: React
→ Installing boxicons-react...

PRO - Main Package - Vue

? Select your Boxicons Plan: PRO
? Enter your Boxicons Pro API Key: ********
✅ .npmrc updated with Pro registry.
? Select installation type: Main Package
? Select framework: Vue
→ Installing @boxicons-pro/vue...

PRO - Individual - React Basic Rounded Bold

? Select your Boxicons Plan: PRO
? Enter your Boxicons Pro API Key: ********
✅ .npmrc updated with Pro registry.
? Select installation type: Individual Packages (Recommended)
? Select framework: React
? Select icon pack: basic
? Select style: rounded
? Select weight: bold
→ Installing @boxicons-pro/react-basic-rounded-bold...

PRO - Individual - JS Duotone Regular Normal

? Select your Boxicons Plan: PRO
? Enter your Boxicons Pro API Key: ********
✅ .npmrc updated with Pro registry.
? Select installation type: Individual Packages (Recommended)
? Select framework: JS
? Select icon pack: duotone
? Select style: regular
? Select weight: normal
→ Installing @boxicons-pro/js-duotone-regular...

PRO - Individual - Svelte Brands

? Select your Boxicons Plan: PRO
? Enter your Boxicons Pro API Key: ********
✅ .npmrc updated with Pro registry.
? Select installation type: Individual Packages (Recommended)
? Select framework: Svelte
? Select icon pack: brands
→ Installing @boxicons-pro/svelte-brands...

Development

cd packages/free/boxicons-cli
npm install
npm link
boxicons

Testing

cd tests/free/boxicons-cli
npm install
npm test