Skip to content

hartemyaakoub/liqaa-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

LIQAA CLI

A terminal for your video infrastructure.

npm version node license

npx @liqaa/cli rooms list

Website · Docs · JS SDK


Install

npm install -g @liqaa/cli
# or use directly without installing
npx @liqaa/cli <command>

Configure

The CLI reads LIQAA_PK and LIQAA_SK from env, or from ~/.liqaa/config.json:

liqaa login # interactive — paste pk/sk, stored in ~/.liqaa/config.json (chmod 600)
liqaa whoami # show current account + plan

Commands

Rooms

liqaa rooms list # all active conversations
liqaa rooms create alice@a.com bob@b.com # create persistent room
liqaa rooms get conv_2f9aBcDe # fetch room state
liqaa rooms end conv_2f9aBcDe # end an active call
liqaa rooms tail # follow new rooms in real-time

Tokens

liqaa token issue user@example.com --name "User"
# → outputs the 1-hour SDK token (use in browser)

Webhooks

liqaa webhooks list
liqaa webhooks create https://you.com/hooks call.started call.ended
liqaa webhooks deliveries 17 --tail
liqaa webhooks delete 17

Diagnostics

liqaa ping # check API + signaling latency from your machine
liqaa status # current LIQAA service health
liqaa logs # recent webhook deliveries (tail -f style)

Project bootstrap

liqaa init nextjs my-app # → npx create-next-app + LIQAA wired in
liqaa init react my-app
liqaa init vanilla my-site

Output formats

liqaa rooms list # human-readable table
liqaa rooms list --json # raw JSON for piping
liqaa rooms list --quiet # IDs only — for scripts
liqaa webhooks list | jq '.[].url'

Shell completion

liqaa completion bash >> ~/.bashrc
liqaa completion zsh >> ~/.zshrc
liqaa completion fish > ~/.config/fish/completions/liqaa.fish

Why a CLI?

For backend engineers, the terminal is home. With this CLI you can:

  • Debug a customer issueliqaa rooms get conv_X shows you exactly when it started, who joined, when it ended
  • Script bulk operations — Bash + --json | jq covers any one-off
  • Replay webhooksliqaa webhooks deliveries 17 --replay 1234 re-fires a delivery for testing
  • Quick smoke testsliqaa ping in CI to verify API health before deploys

License

MIT © TKAWEN — LIQAA Cloud.

About

Official command-line tool for the LIQAA video API · Login, rooms, tokens, webhooks, status

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors