A lightweight, secure real-time collaboration tool for local network file synchronization. Perfect for pair programming, collaborative writing, or any scenario where multiple users need to work on files simultaneously in a local network environment.
- 🔄 Real-time file synchronization across multiple devices
- 🔐 Optional password protection for secure sessions
- 🎯 Automatic session code generation for easy connection
- 👀 Live file change watching and broadcasting
- 🚀 Zero configuration required
- 💻 Works across all major platforms
npm install -g local-collablocal-collab startWith password protection:
local-collab start -p mypasswordlocal-collab join SESSION-CODEWith password:
local-collab join SESSION-CODE -p mypassword- Navigate to the directory you want to share
- Run
local-collab start - Share the generated session code with collaborators
- Start collaborating!
- Create or navigate to your working directory
- Run
local-collab join SESSION-CODE - Files will automatically sync with the host
| Command | Option | Description |
|---|---|---|
start |
-p, --password <password> |
Set a session password |
join |
-p, --password <password> |
Provide session password |
local-collab uses WebSocket connections to establish real-time communication between peers on the same local network. File changes are detected using efficient file system watchers and synchronized across all connected clients.
- Built with TypeScript for type safety
- Uses WebSocket for real-time communication
- Implements file system watching with chokidar
- Supports binary file synchronization
- Minimal network overhead
- Node.js 14.0.0 or higher
- npm 6.0.0 or higher
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the ISC License - see the LICENSE file for details.
If you encounter any issues or have questions, please file an issue on the GitHub repository.
Please note that local-collab is designed for use within trusted local networks. While we implement basic security measures like password protection, you should not use it over untrusted networks without additional security measures.