An open API service indexing awesome lists of open source software.

https://github.com/coreply/coreply

An Android app leveraging your favorite LLM to generate auto-fill suggestions for text messages in real time as you type.
https://github.com/coreply/coreply

ai android android-app android-application groq llm openrouter

Last synced: 8 months ago
JSON representation

An Android app leveraging your favorite LLM to generate auto-fill suggestions for text messages in real time as you type.

Awesome Lists containing this project

README

          

![coreply banner](./docs/static/coreply_banner.png)

**coreply** is an open-source Android app designed to make texting faster and smarter by providing AI-generated auto-fill suggestions while you type. Whether you're replying to friends, family, or colleagues, coreply enhances your typing experience with intelligent, context-aware suggestions.

## Features

![coreply demo](./docs/static/coreply_demo.gif)

- **Real-time AI Suggestions**: Get accurate, context-aware suggestions as you type.
- **Customizable LLM Settings**: Supports any inference service having a OpenAI compatible API.
- **No Data Collection**: All traffic goes directly to the inference API. No data passes through intermediate servers.

## Supported Texting Apps

- WhatsApp
- Instagram
- Tinder
- Hinge
- Line (Beta)
- Signal (Beta)
- Heymandi (Beta)

_DISCLAIMER: coreply is not affiliated with or endorsed by the above-mentioned apps or their parent companies._

## Getting Started

### Prerequisites

- Device running Android 13 or higher
- API key for an OpenAI-compatible inference service, such as [Groq](https://console.groq.com/) and [Openrouter](https://openrouter.ai/)
- ⚠️Do note that OpenAI models are not supported due to the lack to output prefill controls. See [Model Selection & Providers](./docs/models.md) for more details.

### Installation & Usage

1. Download the latest APK from the [releases page](https://github.com/coreply/coreply/releases)
2. Install the APK on your Android device.
3. Setup the app with your API key, baseURL (if not using OpenAI) and model name.
4. Toggle the switch and grant necessary permissions to enable the service.
5. Start typing in your messaging app, and see suggestions appear! Single tap on the suggestion to insert one word, or long press to insert the entire suggestion.

### Build From Source

1. Clone the repository:
2. Open the project in Android Studio.
3. Sync the Gradle files and resolve any dependencies.
4. Build and run the app on your preferred device or emulator.

## Model Selection

See [Model Selection & Providers](./docs/models.md) for details.

## How does it work?

See [Model Selection & Providers](./docs/models.md) for details.

## Example setup with Groq

1. Get your API Keys [here](https://console.groq.com/keys)
2. In the coreply app, set the API Endpoint to `https://api.groq.com/openai/v1/` and the model name to `gemma2-9b-it`, `llama-3.3-70b-versatile`, `llama-3.1-8b-instant`, or any other model listed [here](https://console.groq.com/docs/models)
3. Set the API Key to the key you got in step 1.
4. Grant the necessary permissions as described in the installation section. And you are good to go!

## Contributing

All contributions are welcome! However, the code was based on an old project in 2016, so please be patient with the code quality and expect major architectural changes in the future.

## Roadmap

### Planned Features

- Hosted version
- Support for more messaging apps

### Known Issues

- The app cannot read images, videos, voice notes, or other non-text content. Contextual suggestions may be limited in these cases.
- ~~Autofill suggestions in WhatsApp on a non-English locale may include extra words. This is a known issue and will be fixed in a future release.~~ Fixed in v1.0.
- Banking apps in asia commonly block apps from unknown sources having accessibility services permission due to security reasons. If you are facing this issue, you can setup [an accessibility shortcut](https://support.google.com/accessibility/android/answer/7650693?hl=en#step_1) to toggle the coreply on/off quickly. In the future there might be a Play Store listing to avoid this issue.

## License Notice

coreply

Copyright (C) 2024 coreply

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .