termux-dev-setup (tds)

Your "Batteries Included" Development Environment for Termux.

tds is a powerful CLI tool designed to effortlessly set up and manage a production-grade development environment inside Termux (Proot/Ubuntu). Forget manual configuration files and permission headaches—get your database, cache, and cloud tools running in seconds.

⚡ Quick Start

Prerequisites

• Termux with Proot-Distro (Ubuntu recommended).
• Python 3.8+ installed.
• Basic knowledge of terminal operations.

Installation

Install tds directly from the source with a single command:

pip install .

Or via PyPI (Recommended for users):

pip install termux-dev-setup

Run

Launch the interactive wizard to get started immediately:

tds --interactive

Demo

Get a PostgreSQL database up and running in under a minute:

# 1. Install and Configure PostgreSQL
tds setup postgres

# 2. Start the Server
tds manage postgres start

# 3. Check Status
tds manage postgres status

✨ Features

💎 Core Services

• PostgreSQL: Production-ready setup with pg_ctl. Manage users, databases, and logs effortlessly.
• Redis: Secure, persistent cache with full lifecycle management. Includes password protection and persistence settings.
• OpenTelemetry: Observability out-of-the-box. Install and manage the OTEL Collector for metrics and traces.
• Google Cloud CLI: Seamless installation of gcloud to manage your GCP resources from your pocket.

🚀 Performance & UX

• Interactive Mode: A user-friendly wizard (tds -i) guides you through setup without memorizing flags.
• Smart Validation: Built-in checks for ports, configuration paths, and environment variables prevent errors before they happen.
• Version Control: Specify exactly which version of a service you need (e.g., tds setup postgres --version 15).

🛡️ Security

• Secure Defaults: Redis is configured with protected mode and password support.
• Non-Root Execution: Services run as the current user, avoiding dangerous root permissions in the container.

🛠️ Configuration

Customize your setup using Environment Variables. tds respects these variables during setup and execution, allowing for flexible deployments.

Environment Variables

CLI Arguments

🏗️ Architecture

tds follows a modular architecture, strictly separating the Command Line Interface (CLI) from the core business logic and configuration.

Directory Tree

src/termux_dev_setup/
├── cli.py            # Entry Point: Parses arguments & routes commands
├── config.py         # Configuration: Dataclasses & Env Var Validation
├── errors.py         # Error Handling: Custom TDSError hierarchy
├── gcloud.py         # Module: Google Cloud Installer
├── interactive.py    # UI: Interactive Wizard Logic
├── otel.py           # Module: OpenTelemetry Installer & Manager
├── postgres.py       # Module: PostgreSQL Installer & Manager
├── redis.py          # Module: Redis Installer & Manager
├── service_status.py # Logic: Service health checking
├── views.py          # UI: Rich library views
└── utils/
    ├── banner.py     # UI: CLI ASCII Art & Banner
    └── status.py     # UI: Logging, Success/Error styling

Data Flow

1. User Input: cli.py receives the command or triggers interactive.py.
2. Configuration: config.py loads defaults and overrides with Environment Variables.
3. Validation: Ports and paths are validated before any action is taken.
4. Execution: The respective module (e.g., redis.py) executes the requested action (Setup or Manage).
5. Feedback: utils.status renders the result to the console using formatted output.

🐞 Troubleshooting

Common Issues

Debugging

If a service fails to start, check the specific log files defined in your configuration:

• Postgres: /var/log/postgresql/postgresql.log (default)
• Redis: /var/log/redis/redis-server.log (default)
• OTEL: ~/otel.log (default)

🤝 Contributing

We welcome contributions! Please see our CONTRIBUTING.md for details.

Dev Setup

1. Clone the repository.
2. Install dependencies: pip install .
3. Run tests: pytest
4. Lint code: ruff check .

🗺️ Roadmap

We are constantly improving tds. Here is a snapshot of our upcoming goals:

• Phase 1 (Completed): Core Services (PG, Redis, OTEL, GCloud), Basic Management.
• Phase 2 (Current): Interactive Setup, Version Management.
• Phase 3 (Upcoming): Plugin Architecture, Database Integrations (MySQL/Mongo), Observability Stack.
• Phase 4 (Vision): AI-Powered Tuning, Remote Tunnels.

See ROADMAP.md for the full detailed vision.