Packages
Overview of UCD.js packages and their APIs
Packages
UCD.js is split into focused packages. Install only what you need.
Core Packages
CLI
Explore Unicode data, manage stores, and run pipelines from the terminal.
Client
Type-safe API client for fetching Unicode data files, versions, and manifests.
UCD Store
Manage and mirror Unicode Character Database files locally.
Schemas
Zod schemas for validating UCD configuration and data shapes.
Schema Gen
AI-powered TypeScript field generation from raw UCD data files.
Utilities
Utils
Curated stable helpers — Unicode version validation, API error guards.
Path Utils
Security-focused path resolution with traversal protection and cross-platform support.
Environment
Shared runtime constants and required-binding validation for UCD.js packages.
Advanced
Choosing the right package
| Goal | Package |
|---|---|
| Explore Unicode from the terminal | @ucdjs/cli |
| Query Unicode data programmatically | @ucdjs/client |
| Cache and mirror UCD files locally | @ucdjs/ucd-store |
| Validate Unicode versions or API errors | @ucdjs/utils |
| Resolve user-supplied file paths safely | @ucdjs/path-utils |
| Validate UCD data with Zod | @ucdjs/schemas |
| Generate TypeScript fields from UCD files | @ucdjs/schema-gen |