Getting Started
Installation
Get started with UCD.js.
This documentation is for a pre-release version of UCD.js. The API and features may change before the stable release.
Package Installation
Install UCD.js packages
Install the UCD.js packages you need using your preferred package manager:
npm
npm install @ucdjs/core
pnpm
pnpm add @ucdjs/core
yarn
yarn add @ucdjs/core
Basic Usage
Start using UCD.js in your project:
example.ts
import { getCharacterInfo } from '@ucdjs/core'
const info = getCharacterInfo('A')
console.log(info.name) // LATIN CAPITAL LETTER A
Explore the packages
Check out the packages documentation to learn about all available UCD.js modules.
CLI Installation
Install the CLI globally
Install the UCD.js CLI for global access to Unicode utilities:
Terminal
npm install -g @ucdjs/cli
Explore Unicode data
Use the CLI to explore Unicode characters and properties:
Terminal
ucd char A
ucd block "Basic Latin"
ucd script Latin
Get help
Access help and documentation for CLI commands:
Terminal
ucd --help
ucd char --help