Skip to content

README.md

Latest commit

 

History

History
222 lines (165 loc) · 5.87 KB

README.md

File metadata and controls

222 lines (165 loc) · 5.87 KB
Raw

krinry CLI

🚀 krinry

The Ultimate CLI for Mobile Developers on Termux

Install Features Version License

Flutter • Install • Usage • Contributing

✨ What is krinry?

krinry is a powerful CLI tool designed for mobile developers using Termux on Android. Build Flutter APKs in the cloud, install packages with one command, and develop apps right from your phone!

🎯 Key Features

Feature Description
☁️ Cloud Builds Build Flutter APKs/AABs using GitHub Actions
📦 Package Manager Install Flutter, editors, and tools with one command
🔄 Auto Updates Keep krinry up-to-date automatically
📱 Termux Native Built specifically for Termux on Android
🎨 Beautiful UI Colorful, informative terminal output

📥 Installation

curl -fsSL https://raw.githubusercontent.com/krinry/krinry-cli/dev/install.sh | bash

After installation, restart your terminal or run:

source ~/.bashrc

Requirements

  • Termux (from F-Droid)
  • Internet connection
  • GitHub account (for cloud builds)

🚀 Quick Start

Install Flutter

krinry install flutter

Build APK in Cloud

# Initialize your project
cd your-flutter-project
krinry flutter init

# Build release APK
krinry flutter build apk --release

📖 Usage

Global Commands

Command Description
krinry --help Show help
krinry --version Show version
krinry update Update krinry to latest

Install Commands

# Install Flutter SDK
krinry install flutter

# Install AI Tools
krinry install qwen

# Install Shell enhancements
krinry install oh-my-zsh
krinry install shell-tools

# Install editors
krinry install neovim
krinry install micro

# Install any Termux package as fallback
krinry install <package-name>

Flutter Commands

# Initialize cloud builds in your project
krinry flutter init

# Check system setup
krinry flutter doctor

# Build APK (cloud)
krinry flutter build apk --release
krinry flutter build apk --debug
krinry flutter build apk --split-per-abi

# Build App Bundle
krinry flutter build appbundle --release

# Run web server locally
krinry flutter run web

Build Options

Flag Description
--release Release build (optimized)
--debug Debug build (default)
--split-per-abi Split APK by architecture
--target-platform Build for specific ABI
--install Install APK after download

🔧 How Cloud Builds Work

  1. Initialize - krinry flutter init creates a GitHub Actions workflow
  2. Commit - Push your code to GitHub
  3. Build - krinry flutter build apk triggers the workflow
  4. Download - APK is automatically downloaded when ready
Your Phone (Termux)          GitHub Actions
      │                            │
      ├── krinry flutter init ────►│ Creates workflow
      │                            │
      ├── git push ───────────────►│ Code uploaded
      │                            │
      ├── krinry flutter build ───►│ Triggers build
      │                            │
      │◄── APK downloaded ─────────┤ Build complete
      │                            │

📁 Project Structure

~/.krinry/
├── bin/
│   └── krinry           # Main CLI entry point
├── lib/
│   ├── core.sh          # Core utilities
│   ├── update.sh        # Auto-update
│   ├── install.sh       # Auto-discovery plugin dispatcher
│   ├── installers/      # 📦 PLUGINS: Drop a .sh file here to add a tool!
│   │   ├── qwen.sh
│   │   ├── flutter.sh
│   │   └── ...
│   └── flutter/         # Dedicated flutter core logic
│       ├── init.sh
│       └── build.sh
└── workflows/
    └── krinry-flutter-build.yml

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing)
  5. Open a Pull Request

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Credits

Made with ❤️ by krinry

⭐ Star this repo • 🐛 Report Bug • 💡 Request Feature