bridgelink 0.1.0

CLI tool to expose Android devices remotely via NativeBridge

🌉 BridgeLink

BridgeLink is a production-ready CLI tool that exposes your local Android devices remotely via the NativeBridge platform, making them accessible from anywhere with secure tunneling powered by bore.

---

✨ Features

• 🚀 One-Command Setup - Install and configure in seconds
• 📱 Multi-Device Support - Manage multiple Android devices simultaneously
• 🔐 Secure Tunneling - API key-based authentication via NativeBridge
• 🌍 Remote Access - Access devices from anywhere in the world
• 🤖 Auto-Installation - Automatically installs bore tunnel and ADB
• 💻 Cross-Platform - Works on macOS, Linux, and Windows
• 🔄 Background Management - Tunnels run in the background as daemons
• 📊 Device Tracking - Track device state and connection URLs in real-time
• ✅ Input Validation - Validates device serials via ADB before backend calls
• 🎯 Smart Activation - Intelligently reactivates existing devices

---

🚀 Quick Start

1. Install BridgeLink

pip install bridgelink

2. Install Dependencies

bridgelink install

This automatically installs:

• bore - Tunnel binary for your platform (macOS, Linux, Windows)
• ADB - Android Debug Bridge from Google

3. Set API Key

Get your API key from NativeBridge Dashboard:

export NB_API_KEY='Nb-kNGB.your-api-key-here'

4. Connect Your Device

Connect your Android device via USB and enable USB debugging.

5. Add Device

bridgelink devices add <device-serial>

6. Access Remotely

adb connect bridgelink.nativebridge.io:15750

---

📋 Commands

Device Management

# Add device(s)
bridgelink devices add <serial>
bridgelink devices add <serial1> <serial2>  # Multiple devices

# Activate existing device
bridgelink devices activate <serial>

# List all devices
bridgelink devices list

# Deactivate device (keeps registration)
bridgelink devices deactivate <serial>
bridgelink devices deactivate              # Deactivate ALL active devices (with confirmation)
bridgelink devices deactivate --all        # Deactivate ALL active devices

# Remove device completely
bridgelink devices remove <serial>

Daemon Management

# Check tunnel status
bridgelink daemon status

# View tunnel logs
bridgelink daemon logs <serial>

# Stop tunnel(s)
bridgelink daemon stop <serial>            # Stop specific tunnel
bridgelink daemon stop                     # Stop ALL tunnels (with confirmation)
bridgelink daemon stop --all               # Stop ALL tunnels

# Clean up dead tunnels
bridgelink daemon cleanup

Installation

# Install both bore and ADB
bridgelink install

# Install only bore
bridgelink install --bore-only

# Install only ADB
bridgelink install --adb-only

---

📖 Documentation

For complete documentation, visit the GitHub repository.

Key Guides:

• Security Guide - Security best practices ⚠️ READ FIRST
• Complete Command Reference - All commands with examples
• Deployment Guide - Backend setup and deployment
• Local Testing - Test before PyPI release
• PyPI Release - Publishing guide

---

🔧 Configuration

Environment Variables

Variable	Description	Default
NB_API_KEY	NativeBridge API key	Required
NB_API_URL	Backend API URL	https://dev.api.nativebridge.io
BORE_SERVER	Bore tunnel server	bridgelink.nativebridge.io

State Directory

BridgeLink stores configuration in ~/.bridgelink/:

• tunnels.json - Tunnel state
• tunnel_<serial>.log - Individual tunnel logs

---

🛡️ Security

• ✅ ADB Validation - Device serials validated before backend calls
• ✅ API Key Auth - Secure authentication for all operations
• ✅ User Isolation - Each user only sees their own devices
• ✅ HTTPS - Encrypted communication with backend

---

🤝 Support

• Email: [e-mail]
• Issues: https://github.com/AutoFlowLabs/bridgelink/issues
• Docs: https://docs.nativebridge.io/bridgelink
• API Key: https://nativebridge.io/dashboard/api-keys

---

🙏 Acknowledgments

• bore - Fast, simple TCP tunnel
• ADB - Android Debug Bridge by Google
• Click - Python CLI framework
• FastAPI - Modern Python web framework

---

📄 License

MIT License - see LICENSE file for details.

---

Made with ❤️ by the NativeBridge team