README.md

Cangjie Code

A tool for converting Chinese character into cangjie version 5 (第五代倉頡) code.

Installation

npm install -g cangjie-code

Usage

CLI

$ cangjie --help

  Usage: cangjie [options] <words>

  Options:

    -h, --help     output usage information
    -V, --version  output the version number
    -H, --history  Show history

Query

$ cangjie 你好
你: 人弓火 (onf)
好: 女弓木 (vnd)

Show history

$ cangjie --history
你: 人弓火 (onf)
好: 女弓木 (vnd)

API

import decompose from 'cangjie-code';
// var decompose = require('cangjie-code').default;

decompose('你好').then((result) => {
  // result = {
  //   '你': [{ key: 'onf', code: '人弓火' }],
  //   '好': [{ key: 'vnd', code: '女弓木' }],
  // };
});