Skip to main content

No project description provided

Project description

🕯️ Candles CLI (TeamBridge Ecosystem)

PyPI version Python License

Candles CLI (teambridge-candles) is a developer-focused real-time workspace synchronization tool built for the TeamBridge ecosystem.

It connects your local development environment with TeamBridge cloud workspaces and provides:

  • Real-time file synchronization
  • Cloud workspace management
  • Team collaboration
  • Version tracking
  • Developer workflow automation

🌐 Platform

Workspace Portal:

https://candels1921.vercel.app/


✨ Features

⚡ Real-Time Synchronization

Candles watches your project directory and syncs:

  • New files
  • Updated files
  • Deleted files
  • Folder structures
  • Workspace changes

Architecture:

Local Project

      ↓

Candles CLI

      ↓

File Watcher

      ↓

WebSocket Sync Engine

      ↓

TeamBridge Cloud

      ↓

Workspace Dashboard

🚀 Installation

Install:

pip install teambridge-candles

Run:

candles

or:

cn

Both commands are identical.


🔐 Authentication Commands

Login

cn login

Connect your local CLI with your TeamBridge account.

Example:

🕯️ Candles Authentication

Email:
developer@example.com

Password:
********

✓ Login successful

Logout

cn logout

Clears local authentication session.

Output:

✓ Session cleared safely

Who Am I

cn whoami

Displays:

  • Current user
  • Email
  • Role
  • Connection status

Example:

Candles Account

Name:
Developer

Email:
developer@example.com

Role:
Developer

Connected:
Yes

📂 Workspace Commands

Create Workspace

cn create

Opens TeamBridge workspace creation console.

Creates:

  • Workspace
  • Cloud storage
  • Team configuration

Select Workspace

cn select

Connect an existing workspace to your current folder.

Flow:

Fetch projects

↓

Choose workspace

↓

Select location

↓

Create .candles context

Options:

1. Current folder

2. Create new folder

Creates:

.candles/

   config.json

   workspace.json

Switch Workspace

cn switch <workspace>

Example:

cn switch TeamBridge

Changes current workspace context instantly.


List Workspaces

cn list

Example:

WORKSPACES


ID              NAME

TB-39201        TeamBridge

TB-44192        Portfolio

Delete Workspace

cn delete <workspace>

Deletes:

  • Cloud files
  • History
  • Workspace data

Requires confirmation.


Workspace Info

cn info

Displays:

Workspace Information


Name:
TeamBridge


Files:
240


Storage:
20 MB


Last Sync:
10 seconds ago

⚡ Sync Commands

Start Live Sync

cn link

Starts:

  • File watcher
  • WebSocket connection
  • Real-time upload engine

Example:

Connecting...

✓ WebSocket Connected

Watching project...


Sync Active

Stop Sync

cn unlink

Stops:

  • File watcher
  • Sync connection

Files remain safe locally.


Push Changes

cn push

Uploads local changes manually.

Example:

Scanning...


Added:
app.py


Modified:
App.jsx


✓ Upload Complete

Pull Changes

cn pull

Downloads cloud workspace updates.

Example:

Downloading:


README.md

backend/app.py

frontend/App.jsx


✓ Workspace updated

Compare Changes

cn diff

Shows:

Local changes:

+ new.py

M app.js

- old.css

Remote changes:

M backend.py

📁 File Commands

Delete File

cn drop <file>

Example:

cn drop backend/test.py

Removes:

  • Local file
  • Cloud copy

Restore File

cn restore <file>

Recovers deleted files from workspace history.

Example:

cn restore app.py

File History

cn history <file>

Shows file versions.

Example:

VERSION HISTORY


v3

Modified


v2

Updated


v1

Created

👥 Team Commands

Members

cn members

Shows workspace members.

Example:

TEAM MEMBERS


Developer     Owner

Alex          Developer

Sam           Viewer

Invite Member

cn invite <email>

Example:

cn invite alex@gmail.com

Sends workspace invitation.


⚙️ Configuration Commands

View Config

cn config-get

Displays:

API:
Production


Sync Interval:
2 seconds


Max File Size:
2MB

Update Config

cn config-set <key> <value>

Example:

cn config-set sync 5

Updates local CLI behavior.


🩺 Doctor Command

System Check

cn doctor

Checks:

✓ Python version

✓ Internet connection

✓ API availability

✓ Authentication

✓ Workspace connection

✓ Folder permissions

Example:

Candles Doctor


✓ Python 3.13

✓ API Online

✓ Token Valid

✓ Workspace Linked


Everything looks good

📜 Logs

View Logs

cn logs

Shows:

  • Upload events
  • Delete events
  • Sync activity
  • Errors

Options:

Today:

cn logs --today

Only errors:

cn logs --errors

🚫 Default Ignored Files

Candles automatically ignores:

.git

.candles

node_modules

__pycache__

*.pyc

venv

env

virtualenv

dist

build

Improves:

  • Performance
  • Sync speed
  • Bandwidth usage

🔒 Security

Candles uses:

  • JWT Authentication
  • Secure API requests
  • Session protection
  • Cloud authorization

Passwords are never stored as plain text.


🛠 Technology Stack

Built with:

  • Python
  • Click CLI
  • Watchdog
  • WebSockets
  • REST API
  • JWT
  • Cloud Storage

📦 Package

Install:

pip install teambridge-candles

Commands:

cn login

cn select

cn link

cn pull

cn push

cn status

cn doctor

🔄 Version History

Version Status Description
v1.0.0 Deprecated Initial sync engine
v1.0.1 Stable Sync improvements
v1.0.4 Latest Workspace switching + CLI improvements

🤝 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

teambridge_candles-1.1.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

teambridge_candles-1.1.0-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file teambridge_candles-1.1.0.tar.gz.

File metadata

  • Download URL: teambridge_candles-1.1.0.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for teambridge_candles-1.1.0.tar.gz
Algorithm Hash digest
SHA256 a6db0c487c06fb1bde4c4ba15951aaf33b08c9a700b2d4f15dbb79f30504daae
MD5 df8a71ec6e42d908f4e5795160e057da
BLAKE2b-256 c01c1cf2d0a3b618a4e638ebeea1e057ec62f69a0b89da4bd045ac067d3dba31

See more details on using hashes here.

File details

Details for the file teambridge_candles-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for teambridge_candles-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68f05e94646fb9a99a78f3fbb6f773948feb2c2bb37760bc170faf6432bcfd2d
MD5 a9ca0d8e4eac0691c3fd5d17fd681f55
BLAKE2b-256 c539d66a2ab5c030f60d1219d77897f0cfd7547dfbe33433304d4da0a4a5887c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page