https://github.com/sumanmanna134/offlix-cli
Offlix - A CLI tool for deploying and managing essential development services (MySQL, MongoDB, Kafka, MailDev, PostgreSQL) using Docker Compose. Install, uninstall, and retrieve environment configurations with ease!
https://github.com/sumanmanna134/offlix-cli
automation cli-tool configuration-management devops-tools docker-automation docker-compose docker-compose-environments infrastructure-as-code kafka local-development maildev mongodb mysql python service-management
Last synced: 4 months ago
JSON representation
Offlix - A CLI tool for deploying and managing essential development services (MySQL, MongoDB, Kafka, MailDev, PostgreSQL) using Docker Compose. Install, uninstall, and retrieve environment configurations with ease!
- Host: GitHub
- URL: https://github.com/sumanmanna134/offlix-cli
- Owner: sumanmanna134
- License: mit
- Created: 2024-10-14T05:36:58.000Z (over 1 year ago)
- Default Branch: offlix@v1.0.01
- Last Pushed: 2025-08-23T11:48:38.000Z (10 months ago)
- Last Synced: 2025-09-25T13:25:17.830Z (9 months ago)
- Topics: automation, cli-tool, configuration-management, devops-tools, docker-automation, docker-compose, docker-compose-environments, infrastructure-as-code, kafka, local-development, maildev, mongodb, mysql, python, service-management
- Language: Python
- Homepage:
- Size: 120 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Offlix
Offlix is a command-line tool designed to simplify the deployment and management of common services using Docker Compose. With Offlix, you can easily install, uninstall, and retrieve environment variables for services like MySQL, MongoDB, Kafka, Maildev, and PostgreSQL.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [Environment Variables](#environment-variables)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Easy Installation**: Quickly deploy common services with predefined Docker Compose configurations.
- **Service Management**: Start, stop, and uninstall services with simple commands.
- **Environment Variable Retrieval**: Automatically fetch and display environment variables after service installation.
- **Custom Configurations**: Support for custom Docker Compose files for advanced users.
## Installation
To install Offlix, use pip:
```bash
pip install offlix
```
## Usage
Once Offlix is installed, you can use it from the command line. Here’s how to get started:
```bash
offlix
```
## Commands
### Install a Service:
```bash
offlix install mysql
```
### Uninstall a Service:
```bash
offlix uninstall mysql
```
### Stop a Service:
```bash
offlix stop mysql
```
### Example
### To install MySQL and retrieve its environment variables:
```bash
offlix install mysql
```
### After installation, to get the environment variables:
```python
from offlix import get_service_env
env_vars = get_service_env('mysql')
print(env_vars)
```
### Environment Variables
After installing a service with Docker, you can retrieve its environment variables (like username, password, etc.) using the following command:
```python
from offlix import get_service_env
# Retrieve environment variables for MySQL
mysql_env = get_service_env('mysql')
print(mysql_env)
```
This will display relevant configuration settings required for connecting to the service.
## Contributing
Contributions are welcome! If you have suggestions for improvements or want to report bugs, please open an issue or create a pull request.
Fork the repository.
Create a new branch (git checkout -b feature-branch).
Make your changes and commit them (git commit -m 'Add new feature').
Push to the branch (git push origin feature-branch).
Open a pull request.
## License
This project is licensed under the MIT License. See the LICENSE file for more details.
This project is licensed under the terms of the [MIT License](LICENSE).