feat: transport flags simplified and logs updated

Author: Pratham-Mishra04

README.md

@@ -26,43 +26,38 @@ Bifrost is a high-performance AI gateway that connects you to 8+ providers (Open
 
 📖 For detailed setup guides with multiple providers, advanced configuration, and language examples, see [Quick Start Documentation](./docs/quickstart/README.md)
 
-**Step 1:** Create your config (copy & paste this)
-
-```json
-{
-  "providers": {
-    "openai": {
-      "keys": [
-        {
-          "value": "env.OPENAI_API_KEY",
-          "models": ["gpt-4o-mini"],
-          "weight": 1.0
-        }
-      ]
-    }
-  }
-}
+**Step 1:** Start Bifrost (choose one)
+
+```bash
+# 🐳 Docker (easiest - zero config needed!)
+docker pull maximhq/bifrost
+docker run -p 8080:8080 maximhq/bifrost
+
+# 🔧 Or install Go binary (Make sure Go is in your PATH)
+go install github.com/maximhq/bifrost/transports/bifrost-http@latest
+bifrost-http -port 8080
 ```
 
-**Step 2:** Add your API key
+**Step 2:** Open the built-in web interface
 
 ```bash
-export OPENAI_API_KEY=your_openai_api_key
+# 🖥️ Configure visually - no config files needed!
+open http://localhost:8080
 ```
 
-**Step 3:** Start Bifrost (choose one)
+**Step 3:** Add your provider via the web UI or API
 
 ```bash
-# 🐳 Docker
-docker pull maximhq/bifrost
-docker run -p 8080:8080 \
-  -v $(pwd)/config.json:/app/config/config.json \
-  -e OPENAI_API_KEY \
-  maximhq/bifrost
+# Via Web UI: Just click "Add Provider" and enter your OpenAI API key
+# Or via API:
+curl -X POST http://localhost:8080/providers \
+  -H "Content-Type: application/json" \
+  -d '{
+    "provider": "openai",
+    "keys": [{"value": "env.OPENAI_API_KEY", "models": ["gpt-4o-mini"], "weight": 1.0}]
+  }'
 
-# 🔧 Or install Go binary (Make sure Go is in your PATH)
-go install github.com/maximhq/bifrost/transports/bifrost-http@latest
-bifrost-http -config config.json -port 8080
+# Make sure to set the environment variable OPENAI_API_KEY in bifrost's session, or pass it as a flag in Docker (docker run -e OPENAI_API_KEY maximhq/bifrost).
 ```
 
 **Step 4:** Test it works
@@ -81,11 +76,12 @@ curl -X POST http://localhost:8080/v1/chat/completions \
 
 **🎉 Boom! You're done!**
 
-Your AI gateway is now running and ready for production. You can:
+Your AI gateway is now running with a beautiful web interface. You can:
 
-- Add more providers for automatic failover
-- Scale to thousands of requests per second
-- Drop this into existing OpenAI/Anthropic code with zero changes
+- **🖥️ Configure everything visually** - No more JSON files!
+- **📊 Monitor requests in real-time** - See logs, analytics, and metrics
+- **🔄 Add providers and MCP clients on-the-fly** - Scale and failover without restarts
+- **🚀 Drop into existing code** - Zero changes to your OpenAI/Anthropic apps
 
 > **Want more?** See our [Complete Setup Guide](./docs/quickstart/http-transport.md) for multi-provider configuration, failover strategies, and production deployment.
 
@@ -112,18 +108,20 @@ Your AI gateway is now running and ready for production. You can:
 
 ## ✨ Features
 
-- **Multi-Provider Support**: Integrate with OpenAI, Anthropic, Amazon Bedrock, Mistral, Ollama, and more through a single API
-- **Fallback Mechanisms**: Automatically retry failed requests with alternative models or providers
-- **Dynamic Key Management**: Rotate and manage API keys efficiently with weighted distribution
-- **Connection Pooling**: Optimize network resources for better performance
-- **Concurrency Control**: Manage rate limits and parallel requests effectively
-- **Flexible Transports**: Multiple transports for easy integration into your infra
-- **Plugin First Architecture**: No callback hell, simple addition/creation of custom plugins
-- **MCP Integration**: Built-in Model Context Protocol (MCP) support for external tool integration and execution
-- **Custom Configuration**: Offers granular control over pool sizes, network retry settings, fallback providers, and network proxy configurations
-- **Built-in Observability**: Native Prometheus metrics out of the box, no wrappers, no sidecars, just drop it in and scrape
-- **SDK Support**: Bifrost is available as a Go package, so you can use it directly in your own applications.
-- **Seamless Integration with Generative AI SDKs**: Effortlessly transition to Bifrost by simply updating the `base_url` in your existing SDKs, such as OpenAI, Anthropic, GenAI, and more. Just one line of code is all it takes to make the switch.
+- **🖥️ Built-in Web UI**: Visual configuration, real-time monitoring, and analytics dashboard - no config files needed
+- **🚀 Zero Configuration Startup**: Start immediately, add providers dynamically via web interface or API
+- **🔄 Multi-Provider Support**: Integrate with OpenAI, Anthropic, Amazon Bedrock, Mistral, Ollama, and more through a single API
+- **🛡️ Fallback Mechanisms**: Automatically retry failed requests with alternative models or providers
+- **🔑 Dynamic Key Management**: Rotate and manage API keys efficiently with weighted distribution
+- **⚡ Connection Pooling**: Optimize network resources for better performance
+- **🎯 Concurrency Control**: Manage rate limits and parallel requests effectively
+- **🔌 Flexible Transports**: Multiple transports for easy integration into your infra
+- **🏗️ Plugin First Architecture**: No callback hell, simple addition/creation of custom plugins
+- **🛠️ MCP Integration**: Built-in Model Context Protocol (MCP) support for external tool integration and execution
+- **⚙️ Custom Configuration**: Offers granular control over pool sizes, network retry settings, fallback providers, and network proxy configurations
+- **📊 Built-in Observability**: Native Prometheus metrics out of the box, no wrappers, no sidecars, just drop it in and scrape
+- **🔧 SDK Support**: Bifrost is available as a Go package, so you can use it directly in your own applications
+- **🔄 Seamless Integration with Generative AI SDKs**: Effortlessly transition to Bifrost by simply updating the `base_url` in your existing SDKs, such as OpenAI, Anthropic, GenAI, and more. Just one line of code is all it takes to make the switch
 
 ---
 

docs/README.md

@@ -11,7 +11,7 @@ Choose your preferred way to use Bifrost:
 | **🔧 Go Package**     | Direct integration, maximum control | 2 minutes  | [📖 Go Package Guide](quickstart/go-package.md)         |
 | **🌐 HTTP Transport** | Language-agnostic, microservices    | 30 seconds | [📖 HTTP Transport Guide](quickstart/http-transport.md) |
 
-**New to Bifrost?** Start with [⚡ Quick Start](quickstart/) to get running in under 30 seconds.
+**New to Bifrost?** Start with [⚡ Quick Start](quickstart/) to get running with zero configuration in under 30 seconds.
 
 ---
 

docs/contributing/README.md

@@ -13,14 +13,17 @@ Ready to contribute? Here's your fastest path to making an impact:
 ```bash
 # 1. Fork and clone
 git clone https://github.com/YOUR_USERNAME/bifrost.git
-cd bifrost
+cd bifrost/core  # or bifrost/transports
 
 # 2. Install dependencies
 go mod download
 
 # 3. Verify setup
-go test ./core/...
-cd transports && go build -o bifrost-http
+cd ../tests/core-providers/
+go test -run TestOpenAI # or any provider you want to test
+
+cd ../transports-integrations/
+# read the README.md file in the transports-integrations directory for testing instructions
 
 # 4. You're ready! 🎉
 ```

docs/quickstart/README.md

@@ -25,11 +25,14 @@ Get up and running with Bifrost in under 30 seconds. Choose your preferred integ
 
 ## 🌐 **HTTP Transport** - Choose if you:
 
+- ✅ Want a clean UI for configuration and monitoring
 - ✅ Use any programming language (Python, Node.js, etc.)
 - ✅ Want to keep AI logic separate from your application
 - ✅ Need a centralized AI gateway for multiple services
 - ✅ Prefer REST API integration patterns
 - ✅ Want drop-in compatibility with existing provider SDKs
+- ✅ Want to **add providers on-the-fly** without restarts
+- ✅ Want to **add MCP clients on-the-fly** without restarts
 
 **→ [Start with HTTP Transport](http-transport.md)**
 

docs/quickstart/http-transport.md

@@ -1,12 +1,37 @@
 # 🌐 HTTP Transport Quick Start
 
-Get Bifrost running as an HTTP API in 30 seconds using Docker. Perfect for any programming language.
+Get Bifrost running as an HTTP API in **15 seconds** with **zero configuration**! Perfect for any programming language.
 
-## ⚡ 30-Second Setup
+## 🚀 Zero-Config Setup (15 seconds!)
 
-### 1. Create `config.json`
+### 1. Start Bifrost (No config needed!)
 
-This file should contain your provider settings and API keys.
+```bash
+# 🐳 Docker (fastest)
+docker pull maximhq/bifrost
+docker run -p 8080:8080 maximhq/bifrost
+
+# 🔧 OR Go Binary (Make sure Go is in your PATH)
+go install github.com/maximhq/bifrost/transports/bifrost-http@latest
+bifrost-http -port 8080
+```
+
+### 2. Open the Web Interface
+
+```bash
+# 🖥️ Beautiful web UI for zero-config setup
+open http://localhost:8080
+```
+
+**🎉 That's it!** Configure providers visually, monitor requests in real-time, and get analytics - all through the web interface!
+
+---
+
+## 📂 File-Based Configuration (Optional)
+
+Want to use a config file instead? Bifrost automatically looks for `config.json` in your app directory:
+
+### 1. Create `config.json` in your app directory
 
 ```json
 {
@@ -24,32 +49,77 @@ This file should contain your provider settings and API keys.
 }
 ```
 
-### 2. Set Up Your Environment
-
-Add your environment variable to the session.
+### 2. Set environment variables and start
 
 ```bash
 export OPENAI_API_KEY="your-openai-api-key"
+
+# Docker with volume mount for persistence
+docker run -p 8080:8080 \
+  -v $(pwd):/app/data \
+  -e OPENAI_API_KEY \
+  maximhq/bifrost
+
+# OR Go Binary with app directory
+bifrost-http -app-dir . -port 8080
 ```
 
-### 3. Start the Bifrost HTTP Server
+---
+
+## 📁 Understanding App Directory & Docker Volumes
 
-You can run using Docker or Go binary.
+### **How the `-app-dir` Flag Works**
+
+The `-app-dir` flag tells Bifrost where to store and look for data:
 
 ```bash
-# Docker
-docker pull maximhq/bifrost
-docker run -p 8080:8080 \
-  -v $(pwd)/config.json:/app/config/config.json \
-  -e OPENAI_API_KEY \
-  maximhq/bifrost
+# Use current directory as app directory
+bifrost-http -app-dir .
 
-# OR Go Binary (Make sure Go in your PATH)
-go install github.com/maximhq/bifrost/transports/bifrost-http@latest
-bifrost-http -config config.json -port 8080
+# Use specific directory as app directory
+bifrost-http -app-dir /path/to/bifrost-data
+
+# Default: current directory if no flag specified
+bifrost-http -port 8080
 ```
 
-### 4. Test the API
+**What Bifrost stores in the app directory:**
+
+- `config.json` - Configuration file (if using file-based config)
+- `logs/` - Database logs and request history
+- Any other persistent data
+
+### **How Docker Volumes Work with App Directory**
+
+Docker volumes map your host directory to Bifrost's app directory:
+
+```bash
+# Map current host directory → /app/data inside container
+docker run -p 8080:8080 -v $(pwd):/app/data maximhq/bifrost
+
+# Map specific host directory → /app/data inside container
+docker run -p 8080:8080 -v /host/path/bifrost-data:/app/data maximhq/bifrost
+
+# No volume = ephemeral storage (lost when container stops)
+docker run -p 8080:8080 maximhq/bifrost
+```
+
+### **Persistence Scenarios**
+
+| Scenario                     | Command                                                       | Result                                  |
+| ---------------------------- | ------------------------------------------------------------- | --------------------------------------- |
+| **Ephemeral (testing)**      | `docker run -p 8080:8080 maximhq/bifrost`                     | No persistence, configure via web UI    |
+| **Persistent (recommended)** | `docker run -p 8080:8080 -v $(pwd):/app/data maximhq/bifrost` | Saves config & logs to host directory   |
+| **Pre-configured**           | Create `config.json`, then run with volume                    | Starts with your existing configuration |
+
+### **Best Practices**
+
+- **🔧 Development**: Use `-v $(pwd):/app/data` to persist config between restarts
+- **🚀 Production**: Mount dedicated volume for data persistence
+- **🧪 Testing**: Run without volume for clean ephemeral instances
+- **👥 Teams**: Share `config.json` in version control, mount directory with volume
+
+### 3. Test the API
 
 ```bash
 # Make your first request
@@ -131,31 +201,33 @@ client = genai.Client(
 
 ---
 
-## 🚀 Next Steps (2 minutes each)
+## 🚀 Next Steps (30 seconds each)
+
+### **🖥️ Add Multiple Providers via Web UI**
 
-### **🔗 Add Multiple Providers**
+1. Open `http://localhost:8080` in your browser
+2. Click **"Add Provider"**
+3. Select **OpenAI**, enter your API key, choose models
+4. Click **"Add Provider"** again
+5. Select **Anthropic**, enter your API key, choose models
+6. **Done!** Your providers are now load-balanced automatically
+
+### **📡 Or Add Multiple Providers via API**
 
 ```bash
-# Create config.json
-echo '{
-  "providers": {
-    "openai": {
-      "keys": [{"value": "env.OPENAI_API_KEY", "models": ["gpt-4o-mini"], "weight": 1.0}]
-    },
-    "anthropic": {
-      "keys": [{"value": "env.ANTHROPIC_API_KEY", "models": ["claude-3-sonnet-20240229"], "weight": 1.0}]
-    }
-  }
-}' > config.json
+# Add OpenAI
+curl -X POST http://localhost:8080/providers \
+  -H "Content-Type: application/json" \
+  -d '{"provider": "openai", "keys": [{"value": "env.OPENAI_API_KEY", "models": ["gpt-4o-mini"], "weight": 1.0}]}'
+
+# Add Anthropic
+curl -X POST http://localhost:8080/providers \
+  -H "Content-Type: application/json" \
+  -d '{"provider": "anthropic", "keys": [{"value": "env.ANTHROPIC_API_KEY", "models": ["claude-3-sonnet-20240229"], "weight": 1.0}]}'
 
 # Set environment variables
+export OPENAI_API_KEY="your-openai-key"
 export ANTHROPIC_API_KEY="your-anthropic-key"
-
-# Start with config
-docker run -p 8080:8080 \
-  -v $(pwd)/config.json:/app/config/config.json \
-  -e OPENAI_API_KEY -e ANTHROPIC_API_KEY \
-  maximhq/bifrost
 ```
 
 ### **⚡ Test Different Providers**
@@ -239,12 +311,14 @@ response, err := http.Post(
 
 ## 🔧 Setup Methods Comparison
 
-| Method        | Pros                                            | Use When                         |
-| ------------- | ----------------------------------------------- | -------------------------------- |
-| **Docker**    | No Go installation needed, isolated environment | Production, CI/CD, quick testing |
-| **Go Binary** | Direct execution, easier debugging              | Development, custom builds       |
+| Method          | Pros                                            | Use When                         |
+| --------------- | ----------------------------------------------- | -------------------------------- |
+| **Zero Config** | No files needed, visual setup, instant start    | Quick testing, demos, new users  |
+| **File-Based**  | Version control, automation, deployment         | Production, CI/CD, team setups   |
+| **Docker**      | No Go installation needed, isolated environment | Production, CI/CD, quick testing |
+| **Go Binary**   | Direct execution, easier debugging              | Development, custom builds       |
 
-Both methods require the same `config.json` file and environment variables.
+**Note:** When using file-based config, Bifrost only looks for `config.json` in your specified app directory.
 
 ---
 
@@ -274,10 +348,12 @@ If you're building a Go application and want direct integration, try the **[Go P
 
 ## 💡 Why HTTP Transport?
 
-- ✅ **Language agnostic** - Use from Python, Node.js, PHP, etc.
-- ✅ **Drop-in replacement** - Zero code changes for existing apps
-- ✅ **OpenAI compatible** - All responses follow OpenAI structure
-- ✅ **Microservices ready** - Centralized AI gateway
-- ✅ **Production features** - Health checks, metrics, monitoring
+- **🖥️ Built-in Web UI** - Visual configuration, monitoring, and analytics
+- **🚀 Zero configuration** - Start instantly, configure dynamically
+- **🌐 Language agnostic** - Use from Python, Node.js, PHP, etc.
+- **🔄 Drop-in replacement** - Zero code changes for existing apps
+- **🔗 OpenAI compatible** - All responses follow OpenAI structure
+- **⚙️ Microservices ready** - Centralized AI gateway
+- **📊 Production features** - Health checks, metrics, monitoring
 
 **🎯 Ready for production? Check out [Complete HTTP Usage Guide](../usage/http-transport/) →**