Skip to content

Commit 883dd9a

Browse files
DP-HridayanDP-Hridayan
committed
ignore
1 parent 40422fa commit 883dd9a

3 files changed

Lines changed: 255 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 224 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,229 @@
1-
# Kotlin migration is in progress...
2-
>[!WARNING]
1+
<p align="center">
2+
<img src="https://capsule-render.vercel.app/api?type=waving&height=300&color=gradient&text=aShell%20You&animation=fadeIn&desc=ADB%20at%20your%20fingertips&descAlign=50&descAlignY=55&fontAlignY=35" />
3+
</p>
4+
5+
> **aShell You** is a fully-featured Android shell utility app with **Material Design 3 UI**, letting you run **ADB**, **root** and **shell** commands on your device or others via OTG/wireless, packed in a beautiful and smart interface
6+
7+
</br>
8+
9+
<p align="center">
10+
<a href="https://github.com/DP-Hridayan/aShellYou/stargazers">
11+
<img alt="GitHub stars" src="https://img.shields.io/github/stars/DP-Hridayan/aShellYou?style=for-the-badge&logo=github&label=Stars" />
12+
</a>
13+
<a href="https://github.com/DP-Hridayan/aShellYou/forks">
14+
<img alt="GitHub forks" src="https://img.shields.io/github/forks/DP-Hridayan/aShellYou?style=for-the-badge&logo=github&label=Forks" />
15+
</a>
16+
<a href="https://github.com/DP-Hridayan/aShellYou/issues">
17+
<img alt="GitHub issues" src="https://img.shields.io/github/issues/DP-Hridayan/aShellYou?style=for-the-badge&logo=github&label=Issues" />
18+
</a>
19+
<a href="https://github.com/DP-Hridayan/aShellYou/releases/latest">
20+
<img alt="GitHub release" src="https://img.shields.io/github/v/release/DP-Hridayan/aShellYou?style=for-the-badge&logo=github&label=Release" />
21+
</a>
22+
<a href="https://github.com/DP-Hridayan/aShellYou/releases">
23+
<img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/DP-Hridayan/aShellYou/total?style=for-the-badge&logo=download&label=Downloads" />
24+
</a>
25+
<a href="https://github.com/DP-Hridayan/aShellYou/graphs/contributors">
26+
<img alt="Contributors" src="https://img.shields.io/github/contributors/DP-Hridayan/aShellYou?style=for-the-badge&logo=github&label=Contributors" />
27+
</a>
28+
<a href="https://github.com/DP-Hridayan/aShellYou/blob/main/LICENSE">
29+
<img alt="License" src="https://img.shields.io/github/license/DP-Hridayan/aShellYou?style=for-the-badge&logo=open-source-initiative&label=License" />
30+
</a>
31+
</p>
32+
33+
<p align="center">
34+
<img alt="Platform" src="https://img.shields.io/badge/Platform-Android-3DDC84?style=for-the-badge&logo=android&logoColor=white" />
35+
<img alt="Language" src="https://img.shields.io/badge/Language-Java-007396?style=for-the-badge&logo=java&logoColor=white" />
36+
<img alt="UI" src="https://img.shields.io/badge/UI-XML-E44D26?style=for-the-badge&logo=html5&logoColor=white" />
37+
<img alt="Min SDK" src="https://img.shields.io/badge/MinSDK-26-yellow?style=for-the-badge" />
38+
<img alt="Target SDK" src="https://img.shields.io/badge/TargetSDK-35-blue?style=for-the-badge" />
39+
<a href="https://crowdin.com/project/ashellyou">
40+
<img alt="Crowdin" src="https://img.shields.io/badge/Translation-Crowdin-222222?style=for-the-badge&logo=crowdin&logoColor=white"/>
41+
</a>
42+
</p>
43+
44+
</br>
45+
46+
<h2 align="center">Screenshots</h2>
47+
<div align="center">
48+
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.jpeg" width="25%" style="margin:10px" />
49+
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.jpeg" width="25%" style="margin:10px" />
50+
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.jpeg" width="25%" style="margin:10px" />
51+
<br/>
52+
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/5.jpeg" width="25%" style="margin:10px" />
53+
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/7.jpeg" width="25%" style="margin:10px" />
54+
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/8.jpeg" width="25%" style="margin:10px" />
55+
<br/>
56+
</div>
57+
58+
</br>
59+
60+
## Features
61+
62+
🎨 **Modern Material Design 3 UI**
63+
> Experience a clean, smooth, and responsive user interface built with Material You, adapting to your device's wallpaper and theme settings.
64+
</br>
65+
66+
📲 **Execute Commands with Ease**
67+
> Run ADB shell commands directly on your device using Shizuku, root access, or Wireless Debugging — all without needing a PC.
68+
</br>
69+
70+
🔌 **Control Other Devices**
71+
> Send ADB commands to other Android devices using OTG cable or Wireless Debugging — perfect for developers and tinkerers.
72+
</br>
73+
74+
📚 **Common ADB Command Examples**
75+
> Built-in examples help you understand and run useful commands instantly without memorizing syntax.
76+
</br>
77+
78+
🛠️ **Support for Continuous Commands**
79+
> Seamlessly run long or continuous shell commands like `logcat`, `top`, or `watch` and view live updates without interruptions.
80+
</br>
81+
82+
🔍 **Search in Command Output**
83+
> Quickly find what you're looking for in the output of your last command using the integrated search functionality.
84+
</br>
85+
86+
📝 **Save Output to File**
87+
> Save the output of any command to a `.txt` file for future reference or sharing — handy for logs and debugging.
88+
</br>
89+
90+
📤 **Share Output Instantly**
91+
> One-tap sharing lets you send your output to other apps like Notes, Gmail, or Telegram.
92+
</br>
93+
94+
📑 **Bookmark Commands**
95+
> Save frequently used commands to bookmarks so you can run them again with a single tap.
96+
</br>
97+
98+
🌑 **AMOLED-Friendly Dark Theme**
99+
> Includes a sleek dark mode designed to save battery and look great on AMOLED screens.
100+
</br>
101+
102+
🎉 **Packed with Extras**
103+
> Tons of small but useful features to enhance your productivity and make ADB power-user workflows smoother.
104+
105+
</br>
106+
107+
## Requirements
108+
109+
> * A working **[Shizuku](https://shizuku.rikka.app/)** environment or **root access**
110+
> * Shizuku/Root is **not required** when executing ADB commands on **other devices** using **OTG** or **Wireless Debugging**
111+
112+
<br/>
113+
114+
>[!CAUTION]
3115
>
4-
>This branch is currently incomplete. Features of aShell You are being implemented gradually.
116+
> Using **aShell You** requires basic knowledge of `ADB/Linux commands`.
117+
>**aShell You** is **not responsible** for any harm caused to your device by improper use of ADB commands
118+
119+
<br/>
120+
121+
>[!TIP]
122+
>
123+
> Please visit our **[Wiki](https://github.com/DP-Hridayan/aShellYou/wiki)** for instructions/setup-guides
124+
125+
</br>
126+
127+
## Resources & Links
128+
129+
<p align="start">
130+
<a href="https://github.com/DP-Hridayan/aShellYou/releases/latest/">
131+
<img src="assets/github.png" width="130" alt="GitHub" />
132+
</a>
133+
&nbsp;&nbsp;
134+
<a href="https://apt.izzysoft.de/fdroid/index/apk/in.hridayan.ashell">
135+
<img src="assets/izzy.png" width="130" alt="F-Droid" />
136+
</a>
137+
<br/><br/>
138+
<a href="https://t.me/aShellYou">
139+
<img src="assets/telegram.png" width="180" alt="Join Telegram" />
140+
</a>
141+
<br/><br/>
142+
<a href="https://www.buymeacoffee.com/Hridayan">
143+
<img src="https://github.com/DP-Hridayan/aShellYou/assets/157479796/d0ad79e4-a19e-4686-9f30-dc1cb1e85168" width="200" alt="Buy Me a Coffee" />
144+
</a></p>
145+
146+
</br>
147+
148+
## Translations
149+
150+
<p align="start">
151+
<picture>
152+
<source media="(prefers-color-scheme: dark)" srcset="docs/translations-dark.svg?ts=1761394844">
153+
<source media="(prefers-color-scheme: light)" srcset="docs/translations-light.svg?ts=1761394844">
154+
<img src="translations-light.svg" alt="Translation Progress" />
155+
</picture>
156+
</p>
157+
158+
>[!NOTE]
159+
>
160+
> Help us make this project accessible to more people by contributing translations on **[Crowdin](https://crowdin.com/project/ashellyou)**
161+
>
162+
> Thanks to our Crowdin [translators](docs/translators.md)
163+
164+
</br>
165+
166+
## Task list
167+
168+
<table align="start" style="border-collapse: collapse; margin-top: 20px;">
169+
<tr>
170+
<th style="padding: 8px; border: 1px solid #ddd; text-align: left;">Task</th>
171+
<th style="padding: 8px; border: 1px solid #ddd; text-align: left;">Status</th>
172+
</tr>
173+
<tr>
174+
<td style="padding: 8px; border: 1px solid #ddd;">Wifi ADB Feature</td>
175+
<td style="padding: 8px; border: 1px solid #ddd; color: green;">✅ Done</td>
176+
</tr>
177+
<tr>
178+
<td style="padding: 8px; border: 1px solid #ddd;">Implement root shell</td>
179+
<td style="padding: 8px; border: 1px solid #ddd; color: green;">✅ Done</td>
180+
</tr>
181+
<tr>
182+
<td style="padding: 8px; border: 1px solid #ddd;">Migrate to kotlin</td>
183+
<td style="padding: 8px; border: 1px solid #ddd; color: green;">⏺️ In progress</td>
184+
</tr>
185+
<tr>
186+
<td style="padding: 8px; border: 1px solid #ddd;">Proper localization</td>
187+
<td style="padding: 8px; border: 1px solid #ddd; color: gray;">⬜ To Do</td>
188+
</tr>
189+
<tr>
190+
<td style="padding: 8px; border: 1px solid #ddd;">Fix scripts execution</td>
191+
<td style="padding: 8px; border: 1px solid #ddd; color: gray;">⬜ To Do</td>
192+
</tr>
193+
<tr>
194+
<td style="padding: 8px; border: 1px solid #ddd;">Add Fastboot</td>
195+
<td style="padding: 8px; border: 1px solid #ddd; color: gray;">⬜ To Do</td>
196+
</tr>
197+
</table>
198+
5199
<br/>
6200

201+
## Star history
202+
203+
<a href="https://star-history.com/#DP-Hridayan/aShellYou&Date">
204+
<picture>
205+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=DP-Hridayan/aShellYou&type=Timeline&theme=dark" />
206+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=DP-Hridayan/aShellYou&type=Date" />
207+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=DP-Hridayan/aShellYou&type=Timeline" />
208+
</picture>
209+
</a>
210+
211+
<br></br>
212+
213+
## License
214+
215+
```
216+
Designed and developed by DP Hridayan @2024
217+
This project is licensed under the GNU General Public License v3.0
218+
```
7219
>[!NOTE]
8-
>I am rewriting the whole codebase in kotlin, adopting Jetpack Compose as UI framework.
9220
>
10-
>So migration might take a while!
221+
>Full license copy [here](LICENSE.md)
222+
223+
</br>
224+
225+
## Contributors
226+
<a href="https://github.com/dp-hridayan/ashellyou/graphs/contributors">
227+
<img src="https://contrib.rocks/image?repo=dp-hridayan/ashellyou" />
228+
</a>
229+
</br>

‎SECURITY.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Only the [latest version](https://github.com/DP-Hridayan/ashellyou/releases/latest) of Ashell You is actively supported with security updates.
6+
7+
## Reporting a Vulnerability
8+
9+
If you discover a security vulnerability in Ashell You, please do the following:
10+
11+
1. **Do not open a public issue or pull request.**
12+
2. Instead, email me directly at: **hridayanofficial@gmail.com**
13+
3. Include as much detail as possible (e.g., steps to reproduce, logs, screenshots, etc.).
14+
15+
>I will investigate and respond as soon as possible. Responsible disclosure is appreciated, and you will be credited in the changelog if the issue is confirmed and fixed.
16+
17+
<br/>
18+
19+
>[!IMPORTANT]
20+
>
21+
>- This app allows access to ADB shell commands. Use responsibly.
22+
>- Users are expected to understand the implications of executing shell commands.
23+
>- The app does not elevate privileges by itself (no root or privilege escalation).
24+
25+
>[!TIP]
26+
>Stay secure and responsible!

‎crowdin.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
project_id_env: CROWDIN_PROJECT_ID
2+
api_token_env: CROWDIN_PERSONAL_TOKEN
3+
files:
4+
- source: '**/src/main/res/values/strings.xml'
5+
translation: '**/src/main/res/values-%android_code%/%original_file_name%'

0 commit comments

Comments
 (0)