Skip to main content

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

Project description

Asher CLI

PyPI PyPI - Version Python License CI Coverage Status Ruff

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 on|off|auto, night-light-brightness, history, export [days|month], help, quit
  • Slash commands for app management: /login, /logout, /robots, /robot <index|name>, /pets, /pet <index|name>, /cat on|off|color <hex>, /refresh [seconds|off], /config, /exit
  • Cat animation panel that reacts to robot state
  • Command history (↑/↓ arrows)
  • Real-time updates via WebSocket; 5-minute poll fallback

Install

With pipx (recommended)

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.

With pip

pip install asher-cli
asher

With uv

uv tool install asher-cli
asher

Run from source

git clone https://github.com/karanshukla/asher-cli
cd asher-cli
uv sync
uv run asher

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|auto Set night light mode
night-light-brightness <level> Set brightness (LR5: 0-100; LR4: 25/50/100)
history Show last 25 activity events
export [days|month] Export activity history to CSV in ~/Downloads (default: 30 days)
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
/robots List all robots on the account
/robot <index|name> Switch active robot (selection persists to keyring)
/pets List all pets on the account
/pet <index|name> Switch which pet's name/weight shows in the status bar
/cat on|off Show or hide the cat animation panel
/cat color <hex> Change the cat art colour (e.g. /cat color #ff79c6); /cat reset to revert
/refresh [seconds|off] Change the auto-poll interval or disable it (/refresh 60, /refresh off)
/config Show current runtime settings (robot, refresh rate, cat panel, active pet)
/exit Exit Asher CLI

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

Releasing

# bump version, commit, and tag in one step, then push with tags
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

git push && git push --tags

# then push the release branch to trigger PyPI publish with the new semver
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

Dev Setup

1. Clone and install

git clone https://github.com/karanshukla/asher-cli
cd asher-cli
uv sync                                        # installs all deps including the dev group
git config core.hooksPath .githooks            # lint + type checks run before every push

2. Configure environment (optional)

Copy .env.example to .env and fill in your credentials:

cp .env.example .env
LITTER_ROBOT_USER=your@email.com
LITTER_ROBOT_PASSWORD=yourpassword
ASHER_CLI_DEV_MODE=true    # sets version to "dev" instead of the installed package version

3. Run with hot reload

CSS hot reload — Textual's devtools watch inline CSS strings and .tcss files and reload them in-place without restarting:

uv run poe dev
# equivalent to: textual run --dev asher/__main__.py

Python auto-restart — true in-process reload isn't possible with Textual's event loop, but watchfiles will kill and relaunch the app whenever a .py file changes in asher/:

uv run poe watch
# equivalent to: watchfiles --filter python 'python -m asher' asher

You can combine both — run poe watch for Python changes and it will naturally pick up CSS changes too on restart.

4. Run tests

uv run poe test                  # run all tests
uv run pytest tests/ --cov=asher # with coverage report

5. Lint, format, type-check

uv run poe fix     # auto-fix ruff issues
uv run poe lint    # check only (no fixes)
uv run poe fmt     # check formatting
uv run poe types   # mypy
uv run poe check   # run all of the above + tests (same as CI)

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.1.0.tar.gz (310.0 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.1.0-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for asher_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 90e941c264f58cf1897f7d7f172e6d0aef6f61826ba54293fe3dbe5be9e15c6c
MD5 3a97368321e54a2a1152bb6f15985442
BLAKE2b-256 2645c2052fdc4f8898d4d53490dc7f4facae0954f136bd815635acad82ff1a5e

See more details on using hashes here.

Provenance

The following attestation bundles were made for asher_cli-0.1.0.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.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for asher_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02f8feecb2cde71955adf2bad0e277cca6a189883fc9943033552ec5c4411d2c
MD5 7cedc00f532ca32de115b20745b70721
BLAKE2b-256 e6953e665a0f3333889de9268914f8d6530544deffa0dd1a7f90bdf38607bcb5

See more details on using hashes here.

Provenance

The following attestation bundles were made for asher_cli-0.1.0-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