yantra-app-launcher

A Minimal CLI-based Android App Launcher.

Documentation | Discord | Reddit | Play Store

Features

Blazing Fast: Launch apps, call contacts, or search the web in seconds—no more digging through app drawers.
Productivity First: Built-in tools for notes, todos, alarms, and calculators keep you in the flow.
Deeply Customizable: From themes and fonts to custom aliases and scripts, make the terminal truly yours.
Power User Ready: Execute Lua scripts, integrate with Termux, and automate your daily tasks with init scripts.

Variants

Yantra Launcher is available in 2 variants:

Minimal: For those who want the bare minimum set of commands and features.
Pro: Includes a wide array of useful commands and features. Priced to support the project.

Pre-built Official Versions

Pre-built packages are recommended for most users to ensure Google Play Services compatibility.

Documentation

For a detailed guide on how to use Yantra Launcher, its commands, and customization options, visit our official documentation:

👉 https://codergtm.github.io/yantra-app-launcher/docs/

Building

[!NOTE]
Building and running locally might not give you the smoothest experience. Play Store builds are optimized for your device and language settings and are much smaller in size.

If you are new to Android development, follow these steps to build the project on your machine:

1. Prerequisites

Android Studio: Download and install the latest version of Android Studio.
Git: Ensure you have Git installed to clone the repository.

2. Clone the Repository

Open your terminal or command prompt and run:

bash
git clone https://github.com/coderGtm/yantra-app-launcher.git

3. Open the Project

Launch Android Studio.
Select Open and navigate to the folder where you cloned the repository.
Wait for Android Studio to finish "indexing" and "Syncing Gradle" (this might take a few minutes the first time).

4. Configuration (`local.properties`)

Android Studio generates a local.properties file in the root directory of the project. You need to add some environment variables here for the app to function correctly:

Open local.properties in the project root.
Add the following lines:
```
properties
weatherAPIkey="your-weather-api-key"
backupPassword="your-backup-password"
```
Note: You can leave these as-is, or get an API key from weatherapi.com to use the weather feature.

5. Select a Build Variant

Yantra has different "Variants" (Free and Pro). To choose one:

Locate the Build Variants tab (usually found on the bottom-left edge of Android Studio).
Click it and select a configuration from the dropdown for the :app module:
- freeDebug: Standard minimal version for testing.
- proDebug: Pro version with all features for testing.

6. Run the App

Connect your Android device via USB (with USB Debugging enabled in Developer Options) or start an Emulator.
Click the green Run (Play) button in the top toolbar of Android Studio.

Community & Support

Discord: Join our Community
Reddit: r/YantraLauncher
Support: See support.md for ways to support the project.
FAQs: Visit the FAQs Page for quick answers.

Contribution

Please open an issue before developing large changes to discuss the implementation.
Follow the existing coding style for consistency.
Translation: We welcome help translating Yantra! See the Translator's Guide.