Skip to content
Jahziah Wagner edited this page Aug 29, 2024 · 3 revisions

FAQs

General Questions

Q: Is ClaudeSync free to use?

A: Yes, ClaudeSync is open-source and free to use. However, you will need a Claude.ai account with a Pro or Team plan to get started, as the free plan is not supported.

Q: How often should I sync?

A: The frequency of syncing depends on your workflow. Many users prefer to sync after each significant change or set up scheduled syncing to ensure their data is always up-to-date. You can use the claudesync schedule command to set up automated synchronization at regular intervals.

Q: Can ClaudeSync handle multiple projects simultaneously?

A: Absolutely! ClaudeSync is designed to manage multiple projects efficiently. You can easily switch between projects using the claudesync project set command, and even sync submodules within larger projects.

Q: Is there a limit to the project size ClaudeSync can handle?

A: ClaudeSync is designed to handle projects of various sizes. However, for optimal performance, we recommend keeping individual files under 32KB (which is the default max_file_size setting). For larger projects, consider breaking them down into smaller submodules.

Technical Questions

Q: Can I use ClaudeSync with multiple Claude.ai accounts?

A: Yes, you can use ClaudeSync with multiple accounts. You will need to update your session key by logging out using claudesync auth logout and logging back in with claudesync auth login when switching between accounts.

Q: What happens if a sync is interrupted?

A: If a sync is interrupted, ClaudeSync will attempt to resume from where it left off during the next sync operation. The tool uses file checksums to determine which files need to be updated, ensuring data integrity.

Q: How does ClaudeSync handle large projects with many files?

A: ClaudeSync uses efficient algorithms to handle large projects. It only syncs files that have changed, uses checksums to avoid unnecessary transfers, and provides progress bars for visibility during sync operations.

Q: Can I customize which files are synced?

A: Yes! ClaudeSync respects .gitignore and .claudeignore files in your project directory. You can also define custom file categories in your configuration to sync specific sets of files. Use claudesync category add to create new categories.

Q: How does ClaudeSync handle merge conflicts?

A: ClaudeSync uses a "last write wins" approach by default. If a file has been modified both locally and remotely, the most recent version will be used. However, you can enable two-way sync with the two_way_sync configuration option to get more granular control over conflict resolution.

Billing and Account Questions

Q: Does using ClaudeSync count towards my Claude.ai API usage?

A: No, syncing files and managing projects through ClaudeSync does not count towards your Claude.ai daily API usage limit. However, any interactions within the Claude.ai interface, such as chatting with Claude about your synced files, will count towards your usage.

Q: What Claude.ai plans are supported by ClaudeSync?

A: ClaudeSync supports Claude.ai Pro and Team plans. The free plan is not supported due to limitations in project and file management capabilities.

Security and Privacy

Q: How does ClaudeSync handle my Claude.ai credentials?

A: ClaudeSync uses session keys for authentication, which are stored securely on your local machine. It never stores your Claude.ai password. You can clear all stored session keys at any time using the claudesync auth logout command.

Q: Is my data encrypted during sync?

A: ClaudeSync uses HTTPS for all communications with Claude.ai servers, ensuring that your data is encrypted in transit. However, the files themselves are not encrypted at rest on Claude.ai servers.

Q: Can I use ClaudeSync in environments with strict security requirements?

A: Yes, ClaudeSync is designed with security in mind. It doesn't require any open inbound ports and all communication is outbound to Claude.ai servers. You can also configure proxy settings if needed.

Advanced Features

Q: Can ClaudeSync integrate with my existing CI/CD pipeline?

A: Absolutely! ClaudeSync can be easily integrated into CI/CD pipelines. You can use the claudesync push command in your deployment scripts to ensure your Claude.ai projects are always up-to-date with your latest code.

Q: Is it possible to sync chat conversations along with project files?

A: Yes! ClaudeSync includes a chat pull command that allows you to synchronize your Claude.ai chat conversations to your local machine. This is great for backing up important discussions or analyzing conversation history.

Q: Can I use ClaudeSync programmatically in my Python scripts?

A: While ClaudeSync is primarily a CLI tool, its core functionality is implemented in a way that can be imported and used in Python scripts. Check out the claudesync.syncmanager and claudesync.providers modules for more details.

Troubleshooting

Q: What should I do if I encounter a "403 Forbidden" error?

A: If you encounter a "403 Forbidden" error, it usually means your session has expired. Try logging out with claudesync auth logout and then logging back in with claudesync auth login. If the problem persists, ensure your Claude.ai account has an active Pro or Team subscription.

Q: How can I get more detailed logs for troubleshooting?

A: You can increase the log verbosity by running claudesync config set log_level DEBUG. This will provide more detailed information about the sync process, which can be helpful for troubleshooting.

Q: I'm getting a "Max file size exceeded" error. What should I do?

A: By default, ClaudeSync limits individual file sizes to 32KB. You can increase this limit by running claudesync config set max_file_size <new_size_in_bytes>. However, be cautious with very large files as they may impact sync performance.

Community and Support

Q: How can I contribute to ClaudeSync?

A: We welcome contributions! Check out our GitHub repository and read the CONTRIBUTING.md file for guidelines. You can contribute by reporting bugs, suggesting features, or submitting pull requests.

Q: Is there a community forum for ClaudeSync users?

A: Yes! We have an active Discord community where users can ask questions, share tips, and discuss best practices. Join us at ClaudeSync Discord.

Q: How often is ClaudeSync updated?

A: We strive to release updates regularly, typically every 2-4 weeks. You can stay up-to-date by watching our GitHub repository or running claudesync upgrade to check for and install the latest version.

Clone this wiki locally