Skip to content
emploreadocs

CLI

emplorea-cli drives the same API from the terminal - built for scripts, agents and developers. Output is a human-readable table by default; pass --json for machine output or --quiet for ids only.

Install and authenticate

npm install -g emplorea-cli     # or: npx emplorea-cli

emplorea auth login --key emp_live_your_key_here
emplorea auth status
emplorea auth logout

Employees

emplorea employees list --status active
emplorea employees get <id>
emplorea employees add \
  --first-name Jane --last-name Smith \
  --email [email protected] \
  --type full_time --start 2026-07-01 \
  --jurisdiction AU --role employee
emplorea employees terminate <id> --date 2026-07-31 --reason resignation

Leave

emplorea leave list --status pending
emplorea leave balances --employee <id>
emplorea leave request --employee <id> --type <leave_type_id> \
  --start 2026-07-14 --end 2026-07-18
emplorea leave approve <id>
emplorea leave decline <id> --reason "Coverage needed"

Webhooks and company

emplorea webhooks list
emplorea webhooks add --url https://example.com/hook \
  --events employee.created,leave.approved
emplorea webhooks remove <id>
emplorea company info

Scripting patterns

  • Pipe --json into jq: emplorea employees list --json | jq '.[].email'
  • Use --quiet to capture ids: REQUEST=$(emplorea leave request ... --quiet)
  • Config lives in ~/.emplorea/config.json; EMPLOREA_API_URL overrides the base URL for self-hosted or local testing.