hkopendata-cli

Command line interface for managing supplementary data in NPM package hkopendata.

Installation

Please DO NOT install globally.

npm i hkopendata-cli

To use this CLI, you need to install npx if you did not install before. It is recommended to install globally as it is a useful package to execute binaries in local package.

npm i -g npx

Information

This cli will create a directory .hkopendata in the project root (process.env.PWD) if not exist. All data will be stored in it. Modify or delete files inside with caution or unexpected error may occur.

For more information, check here.

Usage

List downloaded data

npx hkopendata list

Update or download data

By default, it will update all outdated files in .hkopendata

// update outdated files
npx hkopendata pull

// get latest files from github (https://github.com/DemChing/hkopendata/tree/master/downloads)
// Use space to separate multiple packages or files
npx hkopendata pull -f file1.json file2.json -p package1 package2

Detail Usage

Base Commands

Usage: hkopendata [options] [command]

Commands:
  info                      show information of this project
  list [options]            list downloaded files
  pull [options]            get downloaded files from remote
  help [options] [command]  display help for command

List / Pull

Usage: hkopendata list [options] - list downloaded files
Usage: hkopendata pull [options] - get downloaded files from remote

Options:
  -a, --all                    select all files
  -d, --detail                 show detail
  -f, --file <files...>        select specific file(s), space separated
  -p, --package <packages...>  select specific package(s), space separated
  -y, --yes                    yes to all
  -F, --force                  force checking / update
  --skip-check                 do not check if hkopendata is installed
  -h, --help                   display help for command