UCD.js Docs
CLI

files

Browse and download files from the UCD API

ucd files

Browse and download files from the remote UCD API.

ucd files <subcommand> [...flags]

list

List files and directories available at a given path in the UCD API.

ucd files list [path] [...flags]

path is optional — omitting it lists the root.

Flags

FlagDescription
--base-urlBase URL for the UCD API (default: api.ucdjs.dev)
--jsonOutput the directory listing as raw JSON

Examples

# List root
ucd files list

# List files for a specific Unicode version
ucd files list 16.0.0

# List a subdirectory
ucd files list 16.0.0/ucd

# Output as JSON
ucd files list 16.0.0 --json

get

Download and print (or save) a specific file from the UCD API.

ucd files get <path> [...flags]

Flags

FlagDescription
--base-urlBase URL for the UCD API (default: api.ucdjs.dev)
--output, -oWrite file content to this path instead of stdout

Examples

# Print file to stdout
ucd files get 16.0.0/ucd/UnicodeData.txt

# Save to disk
ucd files get 16.0.0/ucd/UnicodeData.txt -o ./UnicodeData.txt

info

Get metadata about a file or directory without downloading its contents.

ucd files info <path> [...flags]

Flags

FlagDescription
--base-urlBase URL for the UCD API (default: api.ucdjs.dev)
--jsonOutput metadata as raw JSON

Examples

ucd files info 16.0.0/ucd/UnicodeData.txt
ucd files info 16.0.0 --json

On this page