-
-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
111 additions
and
119 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,31 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Create a report to help us improve ClaudeSync | ||
| title: '' | ||
| labels: bug | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **Describe the bug** | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| **To Reproduce** | ||
| Steps to reproduce the behavior: | ||
| 1. Go to '...' | ||
| 2. Run command '....' | ||
| 3. See error | ||
|
|
||
| **Expected behavior** | ||
| A clear and concise description of what you expected to happen. | ||
| ### 🐞 ClaudeSync Bug Report | ||
|
|
||
| **Error messages** | ||
| If applicable, provide the full error message or stack trace. | ||
| **1. Environment** | ||
| - **OS:** *e.g., Windows 10, macOS 12.3, Ubuntu 22.04* | ||
| - **Python Version:** *e.g., 3.9.7* | ||
| - **ClaudeSync Version:** *e.g., 1.2.3* | ||
| - **Installation Type:** *New / Upgraded* | ||
|
|
||
| **Screenshots** | ||
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| **Environment (please complete the following information):** | ||
| - OS: [e.g. Windows 10, macOS 11.4, Ubuntu 20.04] | ||
| - Python version: [e.g. 3.8.10] | ||
| - ClaudeSync version: [e.g. 0.4.9] | ||
| **2. Configuration** | ||
| ```bash | ||
| claudesync config ls | ||
| ``` | ||
| *(Please remove any sensitive information)* | ||
|
|
||
| **Configuration** | ||
| Please provide the output of `claudesync config ls` (make sure to remove any sensitive information). | ||
| **3. Steps to Reproduce** | ||
| 1. *Step one* | ||
| 2. *Step two* | ||
| 3. *Step three* | ||
|
|
||
| **Additional context** | ||
| Add any other context about the problem here. For example: | ||
| - Are you using any custom configurations? | ||
| - Did this issue start happening recently, or has it always been a problem? | ||
| - Can you reliably reproduce this issue? If not, how often does it occur? | ||
| **4. Description** | ||
| *What went wrong?* | ||
|
|
||
| **Logs** | ||
| If possible, please provide relevant logs. You can increase the log verbosity by running: | ||
| ``` | ||
| **5. Optional: Logs** | ||
| ```bash | ||
| claudesync config set log_level DEBUG | ||
| # Paste logs here | ||
| ``` | ||
| Then reproduce the issue and provide the logs (make sure to remove any sensitive information). | ||
|
|
||
| --- | ||
|
|
||
| ### 🙏 Thank You for Your Contribution! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,29 @@ | ||
| --- | ||
| name: Feature request | ||
| about: Suggest an idea for ClaudeSync | ||
| title: '' | ||
| labels: enhancement | ||
| assignees: '' | ||
| ### 🌟 Feature Request | ||
|
|
||
| --- | ||
| **1. Feature Title** | ||
| > *A short, descriptive title for the feature.* | ||
| # Feature Request Template | ||
| **2. Description** | ||
| > *Describe the feature you’d like to see implemented.* | ||
| ## 1. Problem Description | ||
| Provide a clear and concise description of the problem you're experiencing. For example: "I'm always frustrated when [...]" | ||
| **3. Benefits** | ||
| > *Explain how this feature will improve ClaudeSync or benefit users.* | ||
| ## 2. Desired Solution | ||
| Outline the solution you would like to see implemented. Be clear and specific about what you want to happen. | ||
| **4. Use Case** | ||
| > *Provide a specific example of how you would use this feature.* | ||
| ## 3. Considered Alternatives | ||
| Describe any alternative solutions or features you have considered. Include why these alternatives may or may not work for your needs. | ||
| **5. Environment (if applicable)** | ||
| - **OS:** e.g., Windows 10, macOS 12.3, Ubuntu 22.04 | ||
| - **Python Version:** e.g., 3.9.7 | ||
| - **ClaudeSync Version:** e.g., 1.2.3 | ||
|
|
||
| ## 4. Use Case | ||
| Explain how you would use this feature and how it would benefit your workflow with ClaudeSync. | ||
| **6. Willingness to Help** | ||
| > *Are you interested in contributing to this feature? (Yes/No)* | ||
| ## 5. Additional Context | ||
| Include any other relevant context, screenshots, or examples that can help in understanding the feature request. | ||
| **7. Additional Context (optional)** | ||
| > *Any other relevant information, screenshots, or examples.* | ||
| --- | ||
|
|
||
| ## 6. Environment (if relevant) | ||
| - **OS:** [e.g. Windows 10, macOS 11.4, Ubuntu 20.04] | ||
| - **Python version:** [e.g. 3.8.10] | ||
| - **ClaudeSync version:** [e.g. 0.3.7] | ||
| ### 🙏 Thank You for Your Contribution! | ||
|
|
||
| ## 7. Willingness to Contribute | ||
| Let us know if you're interested in helping to implement this feature or if you're just suggesting an idea. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,92 @@ | ||
| # ClaudeSync | ||
|
|
||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://pypi.org/project/claudesync/) | ||
| [](https://github.com/jahwag/claudesync/releases) | ||
| [](https://github.com/jahwag/ClaudeSync/actions/workflows/python-package.yml) | ||
| [](https://github.com/jahwag/claudesync/issues) | ||
| [](https://badge.fury.io/py/claudesync) | ||
| [](https://github.com/jahwag/claudesync/releases) | ||
| [](https://github.com/psf/black) | ||
| [](https://github.com/psf/black) | ||
| [](https://github.com/jahwag/claudesync/network/dependencies) | ||
| [](https://github.com/jahwag/claudesync/commits/main) | ||
|
|
||
| ClaudeSync is a powerful tool that bridges your local development environment with Claude.ai projects, enabling seamless synchronization and enhancing your AI-powered workflow. | ||
| ClaudeSync bridges your local development environment with Claude.ai projects, enabling seamless synchronization to enhance your AI-powered workflow. | ||
|
|
||
| > **⚠️ IMPORTANT DISCLAIMER:** | ||
| > | ||
| > ClaudeSync is an independent, open-source project and is not affiliated with, endorsed by, or in any way officially connected to Anthropic or Claude.ai. | ||
| > | ||
| > ClaudeSync's compliance with Anthropic's Terms of Service is currently under review. The use of session keys for automated access and the nature of the synchronization process may potentially violate Anthropic's TOS. We are actively seeking clarification from Anthropic on these matters. | ||
| > | ||
| > **By using ClaudeSync, you acknowledge that:** | ||
| > 1. You are using this tool at your own risk. | ||
| > 2. Your use of ClaudeSync may potentially violate Anthropic's Terms of Service. | ||
| > 3. You are responsible for any consequences that may arise from using this tool. | ||
| > 4. ClaudeSync is not an official Anthropic product and Anthropic does not provide support for it. | ||
| > | ||
| > We recommend reviewing Anthropic's Terms of Service and Usage Policy before using ClaudeSync. We will update this disclaimer and the tool's functionality based on Anthropic's official response. | ||
|  | ||
|
|
||
|  | ||
| ## ⚠️ Disclaimer | ||
|
|
||
| ## 🌟 Key Features | ||
| ClaudeSync is an independent, open-source project **not affiliated** with Anthropic or Claude.ai. By using ClaudeSync, you agree to: | ||
|
|
||
| - 🔄 **Real-time Synchronization**: Automatically keep your local files in sync with Claude.ai projects. | ||
| - 🚀 **Productivity Boost**: Streamline your workflow with efficient file management and reduced manual updates. | ||
| - 💻 **Cross-Platform Compatibility**: Works flawlessly on Windows, macOS, and Linux. | ||
| - 🔒 **Secure**: Prioritizes your data privacy and security. | ||
| - 🛠 **Customizable**: Configurable sync intervals, file filtering, and more. | ||
| 1. Use it at your own risk. | ||
| 2. Acknowledge potential violation of Anthropic's Terms of Service. | ||
| 3. Assume responsibility for any consequences. | ||
| 4. Understand that Anthropic does not support this tool. | ||
|
|
||
| ## ⚠️ Prerequisites | ||
| Please review [Anthropic's Terms of Service](https://www.anthropic.com/legal/consumer-terms) before using ClaudeSync. | ||
|
|
||
| **Claude Plan Requirements:** | ||
| ## 🌟 Features | ||
|
|
||
| - **Supported:** Pro, Team | ||
| - **Not Supported:** Free | ||
| - **File sync**: Synchronize local files with [Claude.ai projects](https://www.anthropic.com/news/projects). | ||
| - **Cross-Platform**: Compatible with [Windows, macOS, and Linux](https://github.com/jahwag/ClaudeSync/releases). | ||
| - **Configurable**: Plenty of [configuration options](https://github.com/jahwag/ClaudeSync/wiki/Quick-reference). | ||
| - **Integratable**: Designed to be easy to integrate into your pipelines. | ||
| - **Secure**: Ensures data privacy and security. | ||
|
|
||
| ## ⚙️ Prerequisites | ||
|
|
||
| ### 📄 Supported Claude.ai plans | ||
|
|
||
| | [Plan](https://www.anthropic.com/pricing) | Supported | | ||
| |--------|-----------| | ||
| | Pro | ✅ | | ||
| | Team | ✅ | | ||
| | Free | ❌ | | ||
|
|
||
| ### 🔑 SSH Key | ||
|
|
||
| Ensure you have an SSH key for secure credential storage. Follow [GitHub's guide](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) to generate and add your SSH key. | ||
|
|
||
| ### 💻 Software | ||
|
|
||
| - **Python**: ≥ [3.10](https://www.python.org/downloads/) | ||
| - **pip**: [Python package installer](https://pip.pypa.io/en/stable/installation/) | ||
|
|
||
| ## 🚀 Quick Start | ||
|
|
||
| 1. **Install ClaudeSync:** | ||
| ```shell | ||
| pip install claudesync | ||
| ``` | ||
| 1. **Install ClaudeSync** | ||
| ```shell | ||
| pip install claudesync | ||
| ``` | ||
|
|
||
| 2. **Log in to your Claude.ai account:** | ||
| ```shell | ||
| claudesync auth login | ||
| ``` | ||
| 2. **Authenticate** | ||
| ```shell | ||
| claudesync auth login | ||
| ``` | ||
|
|
||
| 3. **Create a project:** | ||
| ```shell | ||
| claudesync project create | ||
| ``` | ||
| 3. **Create a Project** | ||
| ```shell | ||
| claudesync project create | ||
| ``` | ||
|
|
||
| 4. **Start syncing:** | ||
| ```shell | ||
| claudesync push | ||
| ``` | ||
| *Note: This performs a one-way sync. Any files not present locally will be deleted from the Claude.ai Project. | ||
| 4. **Start Syncing*** | ||
| ```shell | ||
| claudesync push | ||
| ``` | ||
| **This is a one-way sync. Files not present locally will be removed from the Claude.ai project unless pruning is [disabled](https://github.com/jahwag/ClaudeSync/wiki/Quick-reference#pruning-remote).* | ||
|
|
||
| 📚 Need more details? Check our [Wiki](https://github.com/jahwag/claudesync/wiki) for comprehensive guides and FAQs. | ||
| 📚 [Detailed Guides & FAQs](https://github.com/jahwag/claudesync/wiki) | ||
|
|
||
| ## 🤝 Support ClaudeSync | ||
| ## 🤝 Support & Contribute | ||
|
|
||
| Love ClaudeSync? Here's how you can contribute: | ||
| Enjoying ClaudeSync? Support us by: | ||
|
|
||
| - ⭐ [Star us on GitHub](https://github.com/jahwag/claudesync) | ||
| - 🐛 [Report bugs or request features](https://github.com/jahwag/claudesync/issues) | ||
| - 🌍 [Contribute to the project](CONTRIBUTING.md) | ||
| - 💬 Join our [Discord community](https://discord.gg/pR4qeMH4u4) for discussions and support | ||
| - ⭐ [Starring the Repository](https://github.com/jahwag/claudesync) | ||
| - 🐛 [Reporting Issues](https://github.com/jahwag/claudesync/issues) | ||
| - 🌍 [Contributing](CONTRIBUTING.md) | ||
| - 💬 [Join Our Discord](https://discord.gg/pR4qeMH4u4) | ||
|
|
||
| Your support fuels ClaudeSync's growth and improvement! | ||
| Your contributions help improve ClaudeSync! | ||
|
|
||
| --- | ||
|
|
||
| [Contributors](https://github.com/jahwag/claudesync/graphs/contributors) • [License](https://github.com/jahwag/claudesync/blob/master/LICENSE) • [Report Bug](https://github.com/jahwag/claudesync/issues) • [Request Feature](https://github.com/jahwag/ClaudeSync/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=) | ||
| [Contributors](https://github.com/jahwag/claudesync/graphs/contributors) • [License](https://github.com/jahwag/claudesync/blob/master/LICENSE) • [Report Bug](https://github.com/jahwag/claudesync/issues) • [Request Feature](https://github.com/jahwag/claudesync/issues/new?labels=enhancement&template=feature_request.md) |