claudesync 0.3.1

A tool to synchronize local files with Claude.ai projects

  .oooooo.   oooo                              .o8                .oooooo..o                                   
 d8P'  `Y8b  `888                             "888               d8P'    `Y8                                   
888           888   .oooo.   oooo  oooo   .oooo888   .ooooo.     Y88bo.      oooo    ooo ooo. .oo.    .ooooo.  
888           888  `P  )88b  `888  `888  d88' `888  d88' `88b     `"Y8888o.   `88.  .8'  `888P"Y88b  d88' `"Y8 
888           888   .oP"888   888   888  888   888  888ooo888         `"Y88b   `88..8'    888   888  888       
`88b    ooo   888  d8(  888   888   888  888   888  888    .o    oo     .d8P    `888'     888   888  888   .o8 
 `Y8bood8P'  o888o `Y888""8o  `V88V"V8P' `Y8bod88P" `Y8bod8P'    8""88888P'      .8'     o888o o888o `Y8bod8P' 
                                                                             .o..P'                            
                                                                             `Y8P'                              

ClaudeSync is a powerful tool designed to seamlessly synchronize your local files with Claude.ai projects.

Overview and Scope

ClaudeSync bridges the gap between your local development environment and Claude.ai's knowledge base. At a high level, the scope of ClaudeSync includes:

• Real-time synchronization with Claude.ai projects
• Command-line interface (CLI) for easy management
• Multiple organization and project support
• Automatic handling of file creation, modification, and deletion
• Intelligent file filtering based on .gitignore rules
• Configurable sync interval with cron job support
• Seamless integration with your existing workflow

Roadmap

1. Enhanced support for large file synchronization
2. Improved conflict resolution mechanisms
3. GUI client for easier management
4. Integration with popular IDEs and text editors
5. Support for additional AI platforms beyond Claude.ai

Quick Start

1. Install ClaudeSync:

   pip install claudesync
   

2. Login to Claude.ai:

   claudesync api login claude.ai
   

3. Select an organization:

   claudesync organization select
   

4. Select or create a project:

   claudesync project select
   # or
   claudesync project create
   

5. Start syncing:

   claudesync sync
   

Advanced Usage

API Management

• Login to Claude.ai: claudesync api login claude.ai
• Logout: claudesync api logout
• Set upload delay: claudesync api ratelimit --delay <seconds>

Organization Management

• List organizations: claudesync organization ls
• Select active organization: claudesync organization select

Project Management

• List projects: claudesync project ls
• Create a new project: claudesync project create
• Archive a project: claudesync project archive
• Select active project: claudesync project select

File Management

• List remote files: claudesync ls
• Sync files: claudesync sync

Configuration

• View current status: claudesync status

Scheduled Sync

Set up automatic syncing at regular intervals:

claudesync schedule

Contributing

We welcome contributions! Please see our Contributing Guidelines for more information.

Communication Channels

• Issues: For bug reports and feature requests, please use our GitHub Issues.

License

ClaudeSync is licensed under the MIT License. See the LICENSE file for details.

Related Projects

• Claude.ai: The AI assistant that ClaudeSync integrates with.

---

Made with ❤️ by the ClaudeSync team