booksy-cli

Configuration, profiles and countries

Config keys, files, environment variables and countries.

booksy config path        # where config, credentials and state live
booksy config list
booksy config set country pl
booksy config get watch.interval
booksy config unset proxy
keymeaning
default_profileprofile used without --profile
countrydefault country: es, us, pl, gb, br, ... (default es)
languageAccept-Language sent to Booksy, e.g. en-US; changes service names and summaries
proxyhttp://, https://, socks5:// or socks5h:// URL; never a direct fallback; no credentials
watch.intervaldefault watch interval, e.g. 10m
profiles.NAME.countrya profile's country
profiles.NAME.location.lat / .lng / .labeldefault search centre
sinks.NAME.*notification targets, see watches
api_keyoverride Booksy's public web key (rarely needed; see troubleshooting)

Files

filecontents
~/.config/booksy-cli/config.tomlthe keys above, mode 0600
~/.config/booksy-cli/credentials.tomlsaved logins and device ids, mode 0600
~/.local/share/booksy-cli/state.dbwatches and their history (SQLite)
~/.local/state/booksy-cli/timer logs, the daily update stamp

XDG_CONFIG_HOME, XDG_DATA_HOME and XDG_STATE_HOME move them; BOOKSY_CONFIG moves only config.toml.

Environment

variableeffect
BOOKSY_PROFILE, BOOKSY_COUNTRYsame as --profile, --country
BOOKSY_ACCESS_TOKENlogin for this run only, never saved
BOOKSY_PROXYproxy, may carry credentials
BOOKSY_ERROR_FORMAT=jsonsame as --error-format json
BOOKSY_NO_UPDATE_CHECK=1no daily update notice
NO_COLORno colour in pretty output

Profiles

A profile is one login in one country. booksy profile list, profile use NAME, profile remove NAME (also removes its watches). Names may use letters, digits, ., _ and -.

Countries

Booksy runs a separate site per country; --country (or the profile's country) picks https://{country}.booksy.com. Business ids, categories and treatments differ between countries.

On this page