Metadata-Version: 2.4
Name: teambridge-candles
Version: 1.0.1
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.31.0
Requires-Dist: click>=8.1.0
Requires-Dist: watchdog>=3.0.0
Requires-Dist: python-socketio[client]>=5.11.0
Requires-Dist: inquirer>=3.1.3
Dynamic: description
Dynamic: description-content-type
Dynamic: requires-dist

# 🕯️ Candles CLI (TeamBridge Ecosystem)

[![PyPI version](https://img.shields.io/pypi/v/teambridge-candles.svg)](https://pypi.org/project/teambridge-candles/)
[![Python Version](https://img.shields.io/pypi/pyversions/teambridge-candles.svg)](https://pypi.org/project/teambridge-candles/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Candles CLI (`teambridge-candles`) is a developer-focused terminal synchronization utility built for the TeamBridge workspace ecosystem.

It monitors your local project files, detects changes, and synchronizes them with the TeamBridge cloud workspace in real-time.

---

## 🌐 Platform

Workspace Portal:

https://candels1921.vercel.app/

Production API:

https://candels.onrender.com

---

# ✨ Features

## ⚡ Real-Time Synchronization

Candles CLI watches your project directory and automatically syncs:

- New files
- Updated files
- Deleted files
- Folder changes
- Project structure updates

---

## 🧠 Architecture

Local Project

↓

Candles CLI

↓

File Watcher

↓

WebSocket Sync Engine

↓

TeamBridge Cloud Workspace

↓

Live Dashboard


---

# 🚀 Installation

Install package:

    pip install teambridge-candles


After installation:

    candles


or:

    cn


Both commands are identical.

---

# 📖 Commands

## 🔐 Login

Command:

    cn login


Example:

    Enter your Candles registered email:
    dev@example.com

    Enter password:
    ********


Creates a secure authentication session.

---

## Logout

Command:

    cn logout


Output:

    [Success] Cleared local session storage.

---

# 📂 Workspace Commands

## Initialize Workspace

Command:

    cn init


Output:

    [Success]

    Workspace initialized.


---

## Start Live Sync

Command:

    cn link


Starts the background file watcher.


Example:

    [Sync] Connecting workspace...

    [WebSocket] Connected

    [Start] File watcher running

    Press Ctrl+C to stop


All changes are synced automatically.

---

## Download Workspace

Command:

    cn get


Downloads latest workspace files.


Example:

    [Sync] Downloading files...

    README.md
    backend/app.py
    frontend/src/App.jsx

    [Success]
    Workspace updated.


---

## Delete File

Command:

    cn drop <file_path>


Example:

    cn drop backend/test.py


Removes the file locally and from the cloud workspace.

---

## Status

Command:

    cn status


Displays:

- Current user
- Workspace
- Connection
- Directory path


Example:

    CANDLES CLI STATUS

    User:
    Developer

    Workspace:
    TB-TEAM-ADB9A6

    Connection:
    Connected


---

## Create Workspace

Command:

    cn create


Opens workspace creation page.

---

# 🚫 Ignore System

Candles automatically ignores:

    .git
    .candles
    node_modules
    __pycache__
    *.pyc
    venv
    env
    virtualenv
    dist
    build


Improves:

- Performance
- Speed
- Bandwidth usage

---

# 🔒 Security

Candles provides:

- JWT authentication
- Secure API communication
- Encrypted session handling


Passwords are never stored as plain text.

---

# 🛠 Technology Stack

Built using:

- Python
- Watchdog
- WebSockets
- REST API
- JWT
- Cloud Storage


---

# 📦 Package

Install:

    pip install teambridge-candles


---

# 🔄 Version History

| Version | Status | Description |
|---|---|---|
| v1.0.0 | Deprecated | Initial sync engine |
| v1.0.1 | Latest | Improved synchronization and stability |


---

# 🤝 Contributing

Clone:

    git clone <repository>


Install:

    pip install -r requirements.txt


Create your feature branch and submit changes.

---

# 🛡 License

MIT License


---

# 🕯️ Candles CLI

Code locally. Sync instantly. Build together.
