Installation

This documentation is for a pre-release version of UCD.js. The API and features may change before the stable release.

UCD.js is a modular project, meaning you can install only the specific packages you need. The most common starting point is the CLI.

CLI Installation

The UCD.js CLI provides command-line utilities for Unicode exploration, store management, and code generation.

npm install -g @ucdjs/cli

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

Terminal

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

Access help and documentation for CLI commands:

Terminal

ucd --help
ucd char --help

See the CLI reference for the full list of commands and flags.

If you're building on top of UCD.js programmatically, install the packages you need:

npm install @ucdjs/client

example.ts

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

const client = createClient();

const data = await client.getCharacter('A');
console.log(data);

Check out the Client API Reference to learn more about interacting with the UCD.js client.