Installation

UCD.js is a modular project, meaning you can install only the specific packages you need. The most common packages to install are the Client and the CLI.

Package Installation

Install the UCD.js packages you need using your preferred package manager. For example, to install the client and file system bridge:

npm install @ucdjs/client @ucdjs/fs-bridge

Basic Usage

Start using UCD.js in your project:

import { createClient } from '@ucdjs/client';

// Initialize the client
const client = createClient();

// Fetch Unicode data (example)
const data = await client.getCharacter('A');
console.log(data);

CLI Installation

The UCD.js CLI provides powerful command-line utilities for Unicode exploration and analysis.

Install the CLI globally

npm install -g @ucdjs/cli

Explore Unicode data

Use the CLI to explore Unicode characters and properties directly from your terminal:

ucd char A
ucd block "Basic Latin"
ucd script Latin

Get help

Access help and documentation for CLI commands:

ucd --help
ucd char --help