|
| 1 | +# CoreShell - Secure Cybernetic Terminal Deck |
| 2 | + |
| 3 | +CoreShell is an SSH client and server node manager for Android, designed with a retro-futuristic Cyberpunk aesthetic. It offers an advanced interface for managing remote infrastructure, with integrated Tailscale support and a real-time telemetry dashboard. |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## 🚀 Key Features |
| 8 | + |
| 9 | +- **Server Profile Manager**: Configure and save your SSH nodes with custom parameters (Host, Port, Username). |
| 10 | +- **Tailscale Integration**: Automatic detection and optimized support for Tailscale networks (MagicDNS and 100.x.x.x IPs). |
| 11 | +- **Cyberpunk Aesthetic**: Reactive UI interface with CRT scanline effects, neon animations, and monospace fonts. |
| 12 | +- **Advanced Terminal**: Interactive shell with quick shortcuts for common commands (`ls`, `htop`, `neofetch`, etc.). |
| 13 | +- **SFTP File Explorer**: Browse, download, edit, and delete files on remote servers through an integrated graphical interface. |
| 14 | +- **Key Manager (RSA Keyring)**: Generate and manage RSA-2048 key pairs for secure password-less authentication. |
| 15 | +- **Telemetry Monitoring**: Real-time visualization of CPU, RAM, temperature, and network traffic through oscilloscope-style graphs. |
| 16 | +- **Monitor Widget**: Home screen widget that displays your favorite server status at a glance. |
| 17 | + |
| 18 | +## 🛠️ Technologies Used |
| 19 | + |
| 20 | +- **Kotlin & Jetpack Compose**: Modern and declarative UI. |
| 21 | +- **Room Database**: Secure local persistence for profiles and keys. |
| 22 | +- **Coroutines & Flow**: Asynchronous session and telemetry management. |
| 23 | +- **Material 3**: UI components with "Cyber-Theme" customizations. |
| 24 | +- **Retrofit & Moshi**: Ready for external API integrations. |
| 25 | + |
| 26 | +## 📱 Installation and Build |
| 27 | + |
| 28 | +### Requirements |
| 29 | +- Android 7.0 (API 24) or higher. |
| 30 | +- Android Studio Ladybug (or recent versions). |
| 31 | +- Gradle 9.3.1. |
| 32 | + |
| 33 | +### Build from Terminal |
| 34 | +To generate the release APK: |
| 35 | +```bash |
| 36 | +./gradlew assembleRelease |
| 37 | +``` |
| 38 | +The APK will be generated at: `app/build/outputs/apk/release/app-release.apk` |
| 39 | + |
| 40 | +## 🔒 Security |
| 41 | +CoreShell supports password and RSA key authentication. Private keys are stored locally in the app's encrypted database. Tailscale is recommended for an additional layer of network security. |
| 42 | + |
| 43 | +## 📝 Current Version Notes |
| 44 | +* The current version uses a simulation engine for SSH/SFTP sessions and telemetry. |
| 45 | +* Integration with real SSH libraries (such as JSch) is planned for upcoming iterations. |
| 46 | + |
| 47 | +--- |
| 48 | +*Developed for the underground netrunner community.* |
0 commit comments