open-windsurf


Nameopen-windsurf JSON
Version 0.1.2 PyPI version JSON
download
home_pageNone
SummaryOpen multiple Windsurf (VS Code-based) instances for different directories/paths
upload_time2025-03-05 22:15:40
maintainerNone
docs_urlNone
authorTom Dörr
requires_python<4.0,>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Open Windsurf

<div align="center">

![Windsurf](https://img.shields.io/badge/Windsurf-IDE-007ACC?style=for-the-badge&logo=visual-studio-code&logoColor=white)
![Python](https://img.shields.io/badge/Python-3.8+-3776AB?style=for-the-badge&logo=python&logoColor=white)
![Poetry](https://img.shields.io/badge/Poetry-Package-60A5FA?style=for-the-badge&logo=poetry&logoColor=white)
![License](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)
![Generated](https://img.shields.io/badge/Generated_by-Sonnet_3.7-FF5A00?style=for-the-badge&logo=codeium&logoColor=white)

A simple utility to open multiple Windsurf (VS Code-based) instances for different directories/paths.

[Features](#features) •
[Installation](#installation) •
[Usage](#usage) •
[Examples](#examples) •
[Options](#options)

</div>

## ✨ Features

<div align="center">

🚀 **Multiple Instances** - Open different projects in separate Windsurf windows  
🔍 **Path Validation** - Automatically checks if paths exist  
⚙️ **Flexible Options** - Supports profiles, custom data directories, and more  
💻 **Simple Interface** - Easy to use command-line tool  
📦 **Poetry Package** - Easy installation and dependency management

</div>

## 📦 Installation

<div align="center">

### From Source

```bash
# Clone the repository
git clone https://github.com/yourusername/open-windsurf.git
cd open-windsurf

# Install with Poetry
poetry install

# Activate the virtual environment
poetry shell
```

### Using pip (once published)

```bash
pip install open-windsurf
```

</div>

## 🚀 Usage

<div align="center">

### When installed with Poetry

```bash
# Within Poetry shell
open-windsurf PATH1 PATH2 PATH3 ...

# Or using Poetry run
poetry run open-windsurf PATH1 PATH2 PATH3 ...
```

### When installed with pip

```bash
open-windsurf PATH1 PATH2 PATH3 ...
```

</div>

## 📋 Examples

<div align="center">

### Open two separate Windsurf instances for different projects:

```bash
open-windsurf ~/projects/project1 ~/projects/project2
```

### Open multiple projects with a specific profile:

```bash
open-windsurf --profile coding ~/projects/project1 ~/projects/project2
```

### Open multiple projects and wait for all instances to close:

```bash
open-windsurf --wait ~/projects/project1 ~/projects/project2
```

</div>

## ⚙️ Options

<div align="center">

| Option | Description |
|--------|-------------|
| `--wait` | Wait for all Windsurf instances to close before exiting |
| `--user-data-dir DIR` | Specify a custom user data directory for all instances |
| `--profile PROFILE` | Use a specific profile for all instances |
| `--new-window` | Force opening in new windows |

</div>

## 📋 Requirements

<div align="center">

- Python 3.8+
- Windsurf installed and available in your PATH
- Poetry (for development)

</div>

## 🛠️ Development

<div align="center">

```bash
# Clone the repository
git clone https://github.com/yourusername/open-windsurf.git
cd open-windsurf

# Install development dependencies
poetry install

# Run tests
poetry run pytest

# Format code
poetry run black open_windsurf
poetry run isort open_windsurf
```

</div>

---

<div align="center">

**Generated with ❤️ by [Windsurf](https://codeium.com/windsurf) and [Sonnet 3.7](https://codeium.com/sonnet)**

<sub>Created on March 5, 2025</sub>

</div>

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "open-windsurf",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Tom D\u00f6rr",
    "author_email": "tomdoerr96@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/14/9c/88c761e48c8f5037118cfeb08da0dae75620ad8d751fa50f2a469b09f2fb/open_windsurf-0.1.2.tar.gz",
    "platform": null,
    "description": "# Open Windsurf\n\n<div align=\"center\">\n\n![Windsurf](https://img.shields.io/badge/Windsurf-IDE-007ACC?style=for-the-badge&logo=visual-studio-code&logoColor=white)\n![Python](https://img.shields.io/badge/Python-3.8+-3776AB?style=for-the-badge&logo=python&logoColor=white)\n![Poetry](https://img.shields.io/badge/Poetry-Package-60A5FA?style=for-the-badge&logo=poetry&logoColor=white)\n![License](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)\n![Generated](https://img.shields.io/badge/Generated_by-Sonnet_3.7-FF5A00?style=for-the-badge&logo=codeium&logoColor=white)\n\nA simple utility to open multiple Windsurf (VS Code-based) instances for different directories/paths.\n\n[Features](#features) \u2022\n[Installation](#installation) \u2022\n[Usage](#usage) \u2022\n[Examples](#examples) \u2022\n[Options](#options)\n\n</div>\n\n## \u2728 Features\n\n<div align=\"center\">\n\n\ud83d\ude80 **Multiple Instances** - Open different projects in separate Windsurf windows  \n\ud83d\udd0d **Path Validation** - Automatically checks if paths exist  \n\u2699\ufe0f **Flexible Options** - Supports profiles, custom data directories, and more  \n\ud83d\udcbb **Simple Interface** - Easy to use command-line tool  \n\ud83d\udce6 **Poetry Package** - Easy installation and dependency management\n\n</div>\n\n## \ud83d\udce6 Installation\n\n<div align=\"center\">\n\n### From Source\n\n```bash\n# Clone the repository\ngit clone https://github.com/yourusername/open-windsurf.git\ncd open-windsurf\n\n# Install with Poetry\npoetry install\n\n# Activate the virtual environment\npoetry shell\n```\n\n### Using pip (once published)\n\n```bash\npip install open-windsurf\n```\n\n</div>\n\n## \ud83d\ude80 Usage\n\n<div align=\"center\">\n\n### When installed with Poetry\n\n```bash\n# Within Poetry shell\nopen-windsurf PATH1 PATH2 PATH3 ...\n\n# Or using Poetry run\npoetry run open-windsurf PATH1 PATH2 PATH3 ...\n```\n\n### When installed with pip\n\n```bash\nopen-windsurf PATH1 PATH2 PATH3 ...\n```\n\n</div>\n\n## \ud83d\udccb Examples\n\n<div align=\"center\">\n\n### Open two separate Windsurf instances for different projects:\n\n```bash\nopen-windsurf ~/projects/project1 ~/projects/project2\n```\n\n### Open multiple projects with a specific profile:\n\n```bash\nopen-windsurf --profile coding ~/projects/project1 ~/projects/project2\n```\n\n### Open multiple projects and wait for all instances to close:\n\n```bash\nopen-windsurf --wait ~/projects/project1 ~/projects/project2\n```\n\n</div>\n\n## \u2699\ufe0f Options\n\n<div align=\"center\">\n\n| Option | Description |\n|--------|-------------|\n| `--wait` | Wait for all Windsurf instances to close before exiting |\n| `--user-data-dir DIR` | Specify a custom user data directory for all instances |\n| `--profile PROFILE` | Use a specific profile for all instances |\n| `--new-window` | Force opening in new windows |\n\n</div>\n\n## \ud83d\udccb Requirements\n\n<div align=\"center\">\n\n- Python 3.8+\n- Windsurf installed and available in your PATH\n- Poetry (for development)\n\n</div>\n\n## \ud83d\udee0\ufe0f Development\n\n<div align=\"center\">\n\n```bash\n# Clone the repository\ngit clone https://github.com/yourusername/open-windsurf.git\ncd open-windsurf\n\n# Install development dependencies\npoetry install\n\n# Run tests\npoetry run pytest\n\n# Format code\npoetry run black open_windsurf\npoetry run isort open_windsurf\n```\n\n</div>\n\n---\n\n<div align=\"center\">\n\n**Generated with \u2764\ufe0f by [Windsurf](https://codeium.com/windsurf) and [Sonnet 3.7](https://codeium.com/sonnet)**\n\n<sub>Created on March 5, 2025</sub>\n\n</div>\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Open multiple Windsurf (VS Code-based) instances for different directories/paths",
    "version": "0.1.2",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ec6ca9babc2b17eaaac2213b1372946e1841e409f7643c16ebe1cd23187a63b9",
                "md5": "87f26e06f8958a6be482ea6f3695d87f",
                "sha256": "4f56e69129d23c5696cc1636edbd25633054dc48f6796090d7f832efaeff50bd"
            },
            "downloads": -1,
            "filename": "open_windsurf-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "87f26e06f8958a6be482ea6f3695d87f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 5264,
            "upload_time": "2025-03-05T22:15:39",
            "upload_time_iso_8601": "2025-03-05T22:15:39.095951Z",
            "url": "https://files.pythonhosted.org/packages/ec/6c/a9babc2b17eaaac2213b1372946e1841e409f7643c16ebe1cd23187a63b9/open_windsurf-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "149c88c761e48c8f5037118cfeb08da0dae75620ad8d751fa50f2a469b09f2fb",
                "md5": "bd7abbde709cd7c8284156b4695a98f8",
                "sha256": "0631ce1da3cccb903f1d0a43ac2e83122e8842e88fc6847a63f4eb61f1391261"
            },
            "downloads": -1,
            "filename": "open_windsurf-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "bd7abbde709cd7c8284156b4695a98f8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 4062,
            "upload_time": "2025-03-05T22:15:40",
            "upload_time_iso_8601": "2025-03-05T22:15:40.085492Z",
            "url": "https://files.pythonhosted.org/packages/14/9c/88c761e48c8f5037118cfeb08da0dae75620ad8d751fa50f2a469b09f2fb/open_windsurf-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-05 22:15:40",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "open-windsurf"
}
        
Elapsed time: 0.54716s