README.md

 1# Pebblexus
 2
 3Pebblexus is a Pebble watchapp for checking Plexus quota status from
 4your wrist.
 5
 6Pebblexus groups quota meters from Plexus' management quota endpoint by
 7provider/checker ID. Up/down move between groups, select refreshes the
 8current list, and the footer shows the current page count. The
 9phone-side PebbleKit JS stores the user's Plexus base URL and admin key;
10the key is never sent to the watch.
11
12## Requirements
13
14- `mise`
15- A Plexus instance reachable from the phone
16- A Plexus admin key for that instance
17
18The development environment is described in `mise.toml`. It installs the
19`pebble` CLI through mise's `pipx:pebble-tool` backend, pins the Python
20runtime used by that tool, and adds the Pebble SDK toolchain to `PATH`.
21
22## Build
23
24```sh
25mise run build
26```
27
28`mise run check` runs the same build without requiring an emulator.
29
30## Test on Emery
31
32```sh
33mise run install
34mise run screenshot
35```
36
37Interact with the app from the CLI:
38
39```sh
40mise run emu:up      # previous group
41mise run emu:select  # refresh quotas
42mise run emu:down    # next group
43mise run emu:back    # long-press back
44```
45
46Optional app-icon generation uses the local Pebble skill helper and the
47Pebble tool Python environment, which includes Pillow via mise:
48
49```sh
50mise run icons
51```