Skip to content

genZrizzCode/WCA.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wcasearch.js

Install (global)

npm install -g wcasearch.js

Install (dev)

npm i
npm link

Usage

wca help
wca nearby
wca nearby --place "Los Angeles, CA" --radius-km 80
wca nearby --place "Los Angeles, CA" --radius-km 80 --from 2026-06-01 --to 2026-12-31
wca nearby --place "US"
wca nearby --place "Europe"
wca nearby --place "Beijing" --radius-km 1000 --limit 200 --max-pages 50
wca nearby --place "Beijing" --radius-km 1000 --limit 200 --max-pages 50 --all-at-once
wca nearby --place "Beijing" --radius-km 1000 --limit 200 --live 60
wca nearby --place "Beijing" --radius-km 1000 --limit 200 --live
wca nearby --place "Beijing" --radius-km 1000 --limit 200 --live 60 --debug
wca nearby --place "Beijing" --radius-km 1000 --limit 200 --live 60 --debug ./my-run.log
wca live --place "Beijing" --radius-km 1000 --minutes 60

Example of a log: example.log

Notes:

  • For city/county lookups, this uses Open-Meteo geocoding first, then falls back to Nominatim.
  • If Nominatim blocks requests, set WCAJS_USER_AGENT to a real UA string with contact info.
  • For large queries (--limit >= 200 or --max-pages >= 50), it prints Press ⌃C to exit. and streams results line-by-line.
  • --live polls for new matching competitions and always prints Press ⌃C to exit. at the bottom of each poll cycle.
  • --live with no duration runs indefinitely only if the CLI can enable OS sleep inhibition (macOS: caffeinate, Linux: systemd-inhibit, Windows: PowerShell). If not available, it prints instructions and exits.
  • --debug writes a debug log. In live mode it updates continuously; otherwise it writes the log when the command finishes.

About

A Command Line Tool for the World Cube Association

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors