android-viewmodel

Coding rules for Android ViewModels, the components that hold screen state and coordinate app work. They require StateFlow for changing state, repositories for saved data, and Kotlin coroutines for asynchronous tasks.

In plain words
What is it for?
Use them when creating or changing Android ViewModels that expose screen state, load or save data, or run asynchronous operations.
Why use it?
They keep screen logic consistent and prevent direct storage access, outdated LiveData usage, and mixed approaches to background work.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/baijum/ukulele-companion/android-viewmodel
Clone the repo
git clone --depth 1 https://github.com/baijum/ukulele-companion

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 283 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00283
Opus 5 $0.00000 $0.00142
Sonnet 5 $0.00000 $0.00057
Haiku 4.5 $0.00000 $0.00028

Measured yesterday against content hash c3be850a26a4, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

android-viewmodel scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/android-viewmodel.mdc · 29 lines

What it actually says

Android ViewModel Rules

StateFlow only

ViewModels expose state via StateFlow — do not use LiveData. Use MutableStateFlow internally and expose as StateFlow.

private val _uiState = MutableStateFlow(MyUiState())
val uiState: StateFlow<MyUiState> = _uiState.asStateFlow()

Repository abstraction

ViewModels must not access SharedPreferences directly. All persistence goes through repository classes in the data/ package.

Coroutines only

All async work uses Kotlin coroutines. No RxJava, no callback-based APIs. Use viewModelScope for ViewModel-scoped coroutine launches.

Existing ViewModels

FretboardViewModel, TunerViewModel, PitchMonitorViewModel, ChordLibraryViewModel, FavoritesViewModel, SongbookViewModel, SettingsViewModel, ScalePracticeViewModel, MetronomeViewModel, MelodyViewModel, BackupRestoreViewModel, CustomProgressionViewModel, LearningProgressViewModel, SetlistViewModel, TtsAnnouncementThrottler

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 29 lines · 0 tokens per session scan A c3be850a26a4

Subscribe to this mod's changes

android-viewmodel is a cursor rule published in the GitHub repository baijum/ukulele-companion (13 stars, last pushed 5d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 283 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.