Skip to main content

Terminal dashboard for Litter Robot (LR3/LR4/LR5) via the Whisker cloud API

Project description

Asher CLI

A Claude Code-style terminal dashboard for monitoring and controlling Litter Robot via the Whisker cloud API.

image

Features

  • Live status bar — unit name, online/offline, drawer fill level, last activity, cat weight
  • Human-readable robot status — translates raw API states into plain English (Ready, Cleaning, Cat Detected, Drawer Full, etc.)
  • Scrollable activity log with timestamps
  • Commands: clean, status, lock, unlock, sleep, wake, night-light, history, help, quit
  • Slash commands for app management: /login, /logout, /exit
  • Cat animation panel that reacts to robot state
  • Command history (↑/↓ arrows)
  • Auto-refreshes every 30 seconds

Install

pipx install asher-cli
asher

pipx installs the CLI into an isolated environment and puts asher on your PATH automatically. Install pipx with pip install pipx if you don't have it.

Or with plain pip (ensure Python's Scripts folder is on your PATH):

pip install asher-cli
asher

Or run from source:

git clone https://github.com/karanshukla/asher-cli
cd asher-cli
pip install -e .
asher

Dev setup

uv sync --dev
git config core.hooksPath .githooks   # run lint + tests before every push
uv run poe check   # ruff + mypy + pytest (same as CI)
uv run poe fix     # auto-fix ruff issues
uv run poe test    # tests only
uv run poe types   # mypy only

Credentials

On first run, type /login at the command prompt. Your credentials are saved to the OS keyring (Windows Credential Manager / macOS Keychain / Linux Secret Service) and reused automatically on subsequent runs.

To sign out: /logout

.env fallback (for CI or existing users):

LITTER_ROBOT_USER=your@email.com
LITTER_ROBOT_PASSWORD=yourpassword

Commands

Robot commands

Command Description
clean Start a clean cycle
status Refresh and show what matters — online state, drawer level, last activity
info Full dump of all robot properties (serial, firmware, all settings)
lock / unlock Toggle panel lockout
sleep / wake Toggle sleep mode
night-light on|off Toggle night light
history Show last 25 activity events
clear Clear the log
help Show command list
quit Exit

Slash commands

Command Description
/login Sign in or switch accounts
/logout Sign out and clear saved credentials
/exit Exit Asher CLI

Keyboard shortcuts: Ctrl+L clears the log, Ctrl+C quits.

Releasing

# bump version, commit, and tag in one step
uv run bump-my-version bump patch    # 0.0.1 → 0.0.2
uv run bump-my-version bump minor    # 0.0.2 → 0.1.0
uv run bump-my-version bump major    # 0.1.0 → 1.0.0

# then push the release branch to trigger PyPI publish
git checkout -b release/0.0.2
git push origin release/0.0.2

Troubleshooting

asher not found after pip install asher-cli

Python's Scripts folder isn't on your PATH. Use pipx instead — it handles this automatically:

pip install pipx
pipx install asher-cli
asher

If you're in a virtualenv, deactivate it first:

deactivate
pip install pipx
pipx install asher-cli

pipx: command not found

Run it as a module instead:

python -m pip install pipx
python -m pipx install asher-cli

Testing

uv run pytest

CI runs on Python 3.10 / 3.11 / 3.12 across Ubuntu, Windows, and macOS on every push.

Notes

  • Uses the unofficial pylitterbot library — supports LR3, LR4, LR5, and other Whisker robots
  • The Whisker API is reverse-engineered and may change without notice
  • Auth errors and network failures are shown in the UI with friendly messages

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asher_cli-0.0.2.tar.gz (194.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

asher_cli-0.0.2-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file asher_cli-0.0.2.tar.gz.

File metadata

  • Download URL: asher_cli-0.0.2.tar.gz
  • Upload date:
  • Size: 194.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for asher_cli-0.0.2.tar.gz
Algorithm Hash digest
SHA256 5cd8b450f9ff81163c07911adb6182f910255d50aa18c60c171dcf525c22acab
MD5 0f3f8545ef96d40010639ae8f741a055
BLAKE2b-256 5386eb53d77a4b3ccd88424623745c527cb59b3b72727c5120b0335237f15cde

See more details on using hashes here.

Provenance

The following attestation bundles were made for asher_cli-0.0.2.tar.gz:

Publisher: release.yml on karanshukla/asher-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file asher_cli-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: asher_cli-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for asher_cli-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 04c3f24356f1561f87ff09ab01e607812dbb3b9ca4e8f51ed7fb21ea4c7748e3
MD5 67610ba210466715b2965cbd72ab1586
BLAKE2b-256 13f72f58d0405962d3fede04fca18b2b5ff31862aa031b4a687000adc7581caf

See more details on using hashes here.

Provenance

The following attestation bundles were made for asher_cli-0.0.2-py3-none-any.whl:

Publisher: release.yml on karanshukla/asher-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page