Installation

Install the core package

npm install @vimee/core

yarn add @vimee/core

pnpm add @vimee/core

bun add @vimee/core

With React

If you’re using React, install the React bindings as well:

npm install @vimee/core @vimee/react

yarn add @vimee/core @vimee/react

pnpm add @vimee/core @vimee/react

bun add @vimee/core @vimee/react

With React Component

For a full-featured editor with syntax highlighting powered by Shiki:

npm install @vimee/core @vimee/react @vimee/shiki-editor shiki

yarn add @vimee/core @vimee/react @vimee/shiki-editor shiki

pnpm add @vimee/core @vimee/react @vimee/shiki-editor shiki

bun add @vimee/core @vimee/react @vimee/shiki-editor shiki

With an editor plugin

vimee provides several editor plugins for different use cases:

| Package | Description | |---------|-------------| | @vimee/plugin-textarea | Attach Vim keybindings to any HTML textarea | | @vimee/plugin-monaco | Monaco Editor integration | | @vimee/plugin-codemirror | CodeMirror 6 integration |

Install the one that fits your needs:

npm install @vimee/core @vimee/plugin-textarea

yarn add @vimee/core @vimee/plugin-textarea

pnpm add @vimee/core @vimee/plugin-textarea

bun add @vimee/core @vimee/plugin-textarea

Requirements

Node.js 18+
TypeScript 5.0+ (recommended)