claudesync


Nameclaudesync JSON
Version 0.6.5 PyPI version JSON
download
home_pageNone
SummaryA tool to synchronize local files with Claude.ai projects
upload_time2024-11-30 16:07:15
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2024 Jahziah Wagner Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords sync files claude.ai automation synchronization project management file management cloud sync cli tool command line productivity development tools file synchronization continuous integration devops version control
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ClaudeSync

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![PyPI](https://badge.fury.io/py/claudesync.svg)](https://pypi.org/project/claudesync/)
[![Release](https://img.shields.io/github/release/jahwag/claudesync.svg)](https://github.com/jahwag/claudesync/releases)
[![Build Status](https://github.com/jahwag/ClaudeSync/actions/workflows/python-package.yml/badge.svg)](https://github.com/jahwag/ClaudeSync/actions/workflows/python-package.yml)
[![Issues](https://img.shields.io/github/issues/jahwag/claudesync)](https://github.com/jahwag/claudesync/issues)
[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Dependencies](https://img.shields.io/librariesio/github/jahwag/claudesync)](https://github.com/jahwag/claudesync/network/dependencies)
[![Last Commit](https://img.shields.io/github/last-commit/jahwag/claudesync.svg)](https://github.com/jahwag/claudesync/commits/main)
[![Sponsor jahwag](https://img.shields.io/badge/Sponsor-♥-red)](https://github.com/sponsors/jahwag)


ClaudeSync bridges your local development environment with Claude.ai projects, enabling seamless synchronization to enhance your AI-powered workflow.

![ClaudeSync in Action](claudesync.gif)

## ⚠️ Disclaimer

ClaudeSync is an independent, open-source project **not affiliated** with Anthropic or Claude.ai. By using ClaudeSync, you agree to:

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.

Please review [Anthropic's Terms of Service](https://www.anthropic.com/legal/consumer-terms) before using ClaudeSync.

## 🌟 Features

- **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).
- **Integrate**: 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
    ```

2. **Authenticate**
    ```shell
    claudesync auth login
    ```

3. **Create a Project**
    ```shell
    claudesync project create
    ```

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).*

📚 [Detailed Guides & FAQs](https://github.com/jahwag/claudesync/wiki)

## 🤝 Support & Contribute

Enjoying ClaudeSync? Support us by:

- ⭐ [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)
- 💖 [Sponsor Us](https://github.com/sponsors/jahwag)

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?labels=enhancement&template=feature_request.md)• [Sponsor](https://github.com/sponsors/jahwag)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "claudesync",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "sync, files, Claude.ai, automation, synchronization, project management, file management, cloud sync, cli tool, command line, productivity, development tools, file synchronization, continuous integration, devops, version control",
    "author": null,
    "author_email": "Jahziah Wagner <540380+jahwag@users.noreply.github.com>",
    "download_url": "https://files.pythonhosted.org/packages/25/d7/1e9f67fa3717a62af203c94a76188f28b3e568953902f06eeaa38d1996bc/claudesync-0.6.5.tar.gz",
    "platform": null,
    "description": "# ClaudeSync\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n[![PyPI](https://badge.fury.io/py/claudesync.svg)](https://pypi.org/project/claudesync/)\n[![Release](https://img.shields.io/github/release/jahwag/claudesync.svg)](https://github.com/jahwag/claudesync/releases)\n[![Build Status](https://github.com/jahwag/ClaudeSync/actions/workflows/python-package.yml/badge.svg)](https://github.com/jahwag/ClaudeSync/actions/workflows/python-package.yml)\n[![Issues](https://img.shields.io/github/issues/jahwag/claudesync)](https://github.com/jahwag/claudesync/issues)\n[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Dependencies](https://img.shields.io/librariesio/github/jahwag/claudesync)](https://github.com/jahwag/claudesync/network/dependencies)\n[![Last Commit](https://img.shields.io/github/last-commit/jahwag/claudesync.svg)](https://github.com/jahwag/claudesync/commits/main)\n[![Sponsor jahwag](https://img.shields.io/badge/Sponsor-\u2665-red)](https://github.com/sponsors/jahwag)\n\n\nClaudeSync bridges your local development environment with Claude.ai projects, enabling seamless synchronization to enhance your AI-powered workflow.\n\n![ClaudeSync in Action](claudesync.gif)\n\n## \u26a0\ufe0f Disclaimer\n\nClaudeSync is an independent, open-source project **not affiliated** with Anthropic or Claude.ai. By using ClaudeSync, you agree to:\n\n1. Use it at your own risk.\n2. Acknowledge potential violation of Anthropic's Terms of Service.\n3. Assume responsibility for any consequences.\n4. Understand that Anthropic does not support this tool.\n\nPlease review [Anthropic's Terms of Service](https://www.anthropic.com/legal/consumer-terms) before using ClaudeSync.\n\n## \ud83c\udf1f Features\n\n- **File sync**: Synchronize local files with [Claude.ai projects](https://www.anthropic.com/news/projects).\n- **Cross-Platform**: Compatible with [Windows, macOS, and Linux](https://github.com/jahwag/ClaudeSync/releases).\n- **Configurable**: Plenty of [configuration options](https://github.com/jahwag/ClaudeSync/wiki/Quick-reference).\n- **Integrate**: Designed to be easy to integrate into your pipelines.\n- **Secure**: Ensures data privacy and security.\n\n## \u2699\ufe0f Prerequisites\n\n### \ud83d\udcc4 Supported Claude.ai plans\n\n| [Plan](https://www.anthropic.com/pricing)   | Supported |\n|--------|-----------|\n| Pro    | \u2705        |\n| Team   | \u2705        |\n| Free   | \u274c        |\n\n### \ud83d\udd11 SSH Key\n\nEnsure 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.\n\n### \ud83d\udcbb Software\n\n- **Python**: \u2265 [3.10](https://www.python.org/downloads/)\n- **pip**: [Python package installer](https://pip.pypa.io/en/stable/installation/)\n\n## \ud83d\ude80 Quick Start\n\n1. **Install ClaudeSync**\n    ```shell\n    pip install claudesync\n    ```\n\n2. **Authenticate**\n    ```shell\n    claudesync auth login\n    ```\n\n3. **Create a Project**\n    ```shell\n    claudesync project create\n    ```\n\n4. **Start Syncing***\n    ```shell\n    claudesync push\n    ```\n    **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).*\n\n\ud83d\udcda [Detailed Guides & FAQs](https://github.com/jahwag/claudesync/wiki)\n\n## \ud83e\udd1d Support & Contribute\n\nEnjoying ClaudeSync? Support us by:\n\n- \u2b50 [Starring the Repository](https://github.com/jahwag/claudesync)\n- \ud83d\udc1b [Reporting Issues](https://github.com/jahwag/claudesync/issues)\n- \ud83c\udf0d [Contributing](CONTRIBUTING.md)\n- \ud83d\udcac [Join Our Discord](https://discord.gg/pR4qeMH4u4)\n- \ud83d\udc96 [Sponsor Us](https://github.com/sponsors/jahwag)\n\nYour contributions help improve ClaudeSync!\n\n---\n\n[Contributors](https://github.com/jahwag/claudesync/graphs/contributors) \u2022 [License](https://github.com/jahwag/claudesync/blob/master/LICENSE) \u2022 [Report Bug](https://github.com/jahwag/claudesync/issues) \u2022 [Request Feature](https://github.com/jahwag/claudesync/issues/new?labels=enhancement&template=feature_request.md)\u2022 [Sponsor](https://github.com/sponsors/jahwag)\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Jahziah Wagner  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "A tool to synchronize local files with Claude.ai projects",
    "version": "0.6.5",
    "project_urls": {
        "Bug Tracker": "https://github.com/jahwag/claudesync/issues",
        "Homepage": "https://github.com/jahwag/claudesync"
    },
    "split_keywords": [
        "sync",
        " files",
        " claude.ai",
        " automation",
        " synchronization",
        " project management",
        " file management",
        " cloud sync",
        " cli tool",
        " command line",
        " productivity",
        " development tools",
        " file synchronization",
        " continuous integration",
        " devops",
        " version control"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d828335cad63742fca01f0930337232b0415a988f6f89824c3e3a7ab940b7d3e",
                "md5": "5af53fc6d7622d74541066e6bf4e9e06",
                "sha256": "98e25d33b3ddbdfe9ce41b34f02f80567d26315d974a7df7ef3c539b10034ead"
            },
            "downloads": -1,
            "filename": "claudesync-0.6.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5af53fc6d7622d74541066e6bf4e9e06",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 46966,
            "upload_time": "2024-11-30T16:06:57",
            "upload_time_iso_8601": "2024-11-30T16:06:57.449106Z",
            "url": "https://files.pythonhosted.org/packages/d8/28/335cad63742fca01f0930337232b0415a988f6f89824c3e3a7ab940b7d3e/claudesync-0.6.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "25d71e9f67fa3717a62af203c94a76188f28b3e568953902f06eeaa38d1996bc",
                "md5": "f23d981fabb26fdf20770fea09bd5f84",
                "sha256": "f64c5394b12287d28152c2e68967a80001c09b4ea4fca5492d7e67a91386a62c"
            },
            "downloads": -1,
            "filename": "claudesync-0.6.5.tar.gz",
            "has_sig": false,
            "md5_digest": "f23d981fabb26fdf20770fea09bd5f84",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 41306,
            "upload_time": "2024-11-30T16:07:15",
            "upload_time_iso_8601": "2024-11-30T16:07:15.296854Z",
            "url": "https://files.pythonhosted.org/packages/25/d7/1e9f67fa3717a62af203c94a76188f28b3e568953902f06eeaa38d1996bc/claudesync-0.6.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-30 16:07:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jahwag",
    "github_project": "claudesync",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "claudesync"
}
        
Elapsed time: 0.64825s