Metadata-Version: 2.4
Name: multi-workspace
Version: 3.2.1
Summary: Multi
Project-URL: Repository, https://github.com/gabemontague/multi
Project-URL: Issues, https://github.com/gabemontague/multi/issues
Author-email: Gabe Montague <gabemontague@outlook.com>
License-File: LICENSE
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Version Control :: Git
Requires-Python: >=3.12
Requires-Dist: click>=8.3.1
Requires-Dist: gitpython>=3.1.0
Requires-Dist: pyyaml>=6.0.2
Provides-Extra: dev
Requires-Dist: pyinstaller>=6.9.0; extra == 'dev'
Requires-Dist: pytest-cov>=6.1.1; extra == 'dev'
Requires-Dist: pytest-mock>=3.14.0; extra == 'dev'
Requires-Dist: pytest>=8.3.5; extra == 'dev'
Requires-Dist: ruff>=0.11.10; extra == 'dev'
Requires-Dist: zensical; extra == 'dev'
Description-Content-Type: text/markdown

# multi

`multi` is a better way to work with VS Code/Cursor on multiple Git repos at once. It is an alternative to [multi-root workspaces](https://code.visualstudio.com/docs/editing/workspaces/multi-root-workspaces) that offers more flexibility and control. With `multi`, you can gain control over how tasks, debug runnables, and various IDE and linter settings are combined from multiple project repos ("sub-repos") located within a root workspace folder.

**[Documentation](https://multi.bighelp.ai/)**

Features:

- Generates files in your root `.vscode` folder from sub-repo `launch.json`, `tasks.json`, and `settings.json` files.
- Generates `CLAUDE.md` files from Cursor rules.
- In monorepo mode, syncs sub-repo GitHub workflows into root `.github/workflows`.

## Installation

### Using `pipx`:

- Install [pipx](https://github.com/pypa/pipx)
- Run `pipx install multi-workspace`

### Using `uv`

- Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
- Run `uv tool install multi-workspace`

## Getting started

To get started, create a new workspace directory that will house all your related repos and run:

```
multi init
```

When prompted, paste in the URLs of all the repositories you want to have in your workspace. You can optionally specify descriptions of what they do, which will be used to create a new repo-directories.mdc Cursor/Claude rule.

For automation, create or edit `multi.json` directly and run `multi sync`.

It is recommended you also install the [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=montaguegabe.multi-workspace) that automatically keeps your project synced when edits are made to synced files. To manually sync, you can run `multi sync`.
