ilia/crkl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
crkl/README.md
ilia c351858749 Update project configuration files and enhance documentation 
- Updated `.gitignore` and `.cursorignore` to exclude additional build artifacts and temporary files.
- Enhanced `.cursorrules` with comprehensive AI guidelines and best practices.
- Improved `.notes/directory_structure.md` to reflect the current project structure and module organization.
- Updated `ARCHITECTURE.md` to include new insights on the system's modular design and privacy-first approach.
- Refined `README.md` for clarity on project setup and usage instructions.
- Added new entries in `.notes/meeting_notes.md` to document recent progress and decisions.
- Ensured all changes align with the project's privacy and security standards.
2025-10-18 14:32:33 -04:00

2.1 KiB
Raw Blame History

Crkl - On-Device AI Assistant

Privacy-first Android AI assistant that lets users circle or touch any element on their screen, then calls a fully on-device AI engine to transcribe, summarize, explain, or draft responses.

Features

  • System-wide accessibility overlay
  • Touch/gesture detection
  • Local AI inference (no cloud calls)
  • Privacy: No data leaves device

Quick Start

1. Connect Your Android Phone

See PHONE_SETUP.md for detailed setup instructions.

2. Build and Install

make build      # Build APK
make install    # Install to phone
make run        # Launch app

3. Enable Accessibility Service

  1. Open Crkl app (shows welcome screen)
  2. Tap "Open Accessibility Settings"
  3. Find "Crkl Overlay Service" and toggle ON
  4. Accept permission dialog

4. Test It

make logs       # Watch logs

Touch your phone screen anywhere - you'll see touch detection logs and visual feedback (cyan circles).

Commands

make build      # Build APK
make install    # Install to phone
make run        # Launch app
make logs       # Watch app logs
make stop       # Stop app
make clean      # Clean build
make uninstall  # Remove app

Project Structure

crkl/
├── app/src/main/kotlin/com/example/crkl/
│   ├── MainActivity.kt                    # Main app activity
│   ├── accessibility/
│   │   ├── CrklAccessibilityService.kt   # System overlay service
│   │   └── OverlayView.kt                # Touch detection view
│   └── ui/theme/                         # App theming
├── app/src/main/res/                     # Resources
├── Makefile                              # Build commands
├── PHONE_SETUP.md                        # Phone setup guide
└── README.md                             # This file

Development

The POC is complete with:

  • ✅ System-wide overlay
  • ✅ Touch detection
  • ✅ Visual feedback
  • ✅ Logging

Next: Add gesture recognition, content detection, and AI integration.

Requirements

  • Android phone (Android 8.1+)
  • Android SDK on Linux
  • USB debugging enabled