multiflow-cli
Version:
Multi-repo workflow orchestration CLI - streamline feature development across multiple repositories
227 lines (169 loc) ⢠8.1 kB
Markdown
# š MultiFlow
> **Manage your multi-repo projects like a single codebase. One command, all repositories, zero hassle.**
[](https://www.npmjs.com/package/multiflow-cli)
[](https://github.com/arunprabusiva/multiflow-cli/actions/workflows/ci.yml)
[](https://opensource.org/licenses/MIT)
**MultiFlow streamlines multi-repository development** by treating your entire workspace as a single project:
```bash
mflow feature create user-auth # Creates branches everywhere
mflow feature commit user-auth -m "Add login" # Commits to all repos
mflow status user-auth # Shows status across all repos
```
## š The Developer Impact
### The Problem Every Developer Faces
```bash
# The OLD way (30 minutes of pain):
cd frontend && git checkout -b feature/new-ui
cd ../backend && git checkout -b feature/new-ui
cd ../api && git checkout -b feature/new-ui
cd ../docs && git checkout -b feature/new-ui
# Repeat for every operation... š«
```
```bash
# The MultiFlow way (30 seconds):
mflow feature create new-ui
# ā
Done! All repos synchronized instantly
```
**Result: 95% time reduction + zero coordination errors**
### Why Developers Love MultiFlow
- šÆ **Universal Problem**: Every multi-repo developer needs this
- ā” **Instant Value**: Works in 60 seconds after install
- š”ļø **Error Prevention**: Impossible to miss repositories
- š„ **Team Sync**: Everyone knows what's happening everywhere
- š¢ **Enterprise Ready**: Profiles, auth, corporate support
## š Quick Start
### Local Installation
```bash
npm install -g multiflow-cli
cd /path/to/your/workspace
mflow init
mflow feature create my-awesome-feature
```
### Corporate/Restricted Environments
```bash
npx multiflow-cli init # No installation needed
```
š¼ **Corporate users?** See our [Corporate Installation Guide](docs/CORPORATE-INSTALL.md) for restricted environments.
**That's it!** MultiFlow automatically discovers your repositories and you're ready to go.
## ⨠What You Get
### šÆ **One Command, All Repos**
```bash
mflow feature create payment-system
# ā
Creates feature/payment-system in frontend/
# ā
Creates feature/payment-system in backend/
# ā
Creates feature/payment-system in mobile/
# ā
Creates feature/payment-system in docs/
```
### š **Synchronized Operations**
```bash
mflow feature commit payment-system -m "Add Stripe integration"
# ā
Commits changes in all repositories that have modifications
# ā
Uses the same commit message everywhere
# ā
Skips repos with no changes
```
### š **Visual Status Dashboard**
```bash
mflow status payment-system
```
```
payment-system
āā frontend: feature/payment-system ā
ready (3 files changed)
āā backend: feature/payment-system ā
ready (5 files changed)
āā mobile: feature/payment-system āŖ no changes
āā docs: feature/payment-system ā
ready (1 file changed)
```
### š„ **Team Workflows with Profiles**
```bash
# Frontend team works on UI repos only
mflow profile create frontend --repos frontend mobile docs
mflow profile switch frontend
# Backend team works on API repos only
mflow profile create backend --repos backend database api
mflow profile switch backend
# Now all commands only affect your team's repositories!
```
### š **Instant PR Creation**
```bash
mflow pr payment-system --title "Add Stripe payment integration"
```
```
š frontend: https://github.com/yourorg/frontend/compare/main...feature/payment-system
š backend: https://github.com/yourorg/backend/compare/main...feature/payment-system
š mobile: https://github.com/yourorg/mobile/compare/main...feature/payment-system
```
**Click links to create PRs instantly!**
## š Core Features
| Feature | Command | Learn More |
|---------|---------|------------|
| **Feature Management** | `mflow feature create user-auth` | [Feature Workflows](docs/FEATURES.md#feature-management) |
| **Cross-Repo Operations** | `mflow pull` `mflow push` | [Git Operations](docs/FEATURES.md#git-operations) |
| **Team Profiles** | `mflow profile create frontend` | [Profile System](docs/FEATURES.md#profiles) |
| **Health Monitoring** | `mflow doctor` | [Workspace Health](docs/FEATURES.md#health-monitoring) |
| **PR Generation** | `mflow pr user-auth` | [Pull Requests](docs/FEATURES.md#pull-requests) |
| **Status Dashboard** | `mflow status user-auth` | [Status Tracking](docs/FEATURES.md#status-tracking) |
š **[View All Commands](docs/COMMANDS.md)** | š **[Advanced Usage](docs/ADVANCED.md)** | š **[Developer Impact](docs/DEVELOPER-IMPACT.md)**
## šÆ Simple Example
**Building a user authentication feature across multiple repositories:**
```bash
# Create feature branches everywhere
mflow feature create user-auth
# Make your changes in any repositories...
# Then commit across all repos at once
mflow feature commit user-auth -m "Add user authentication"
# Check progress across all repos
mflow status user-auth
# Generate PR URLs for all repos
mflow pr user-auth --title "Add user authentication system"
# Clean up when done
mflow feature cleanup user-auth
```
**Result:** One workflow, all repositories synchronized.
š **[See More Examples](docs/GUIDE.md)** with real-world scenarios and advanced workflows.
## š Advanced Capabilities
- **š„ Health Monitoring** - Check workspace status across all repos
- **š Synchronized Operations** - Pull, push, checkout across all repos
- **ā” Smart Conflict Detection** - Identify merge conflicts before they happen
- **š Visual Status Dashboard** - See progress across all repositories
- **š„ Team Profiles** - Work with repository subsets (frontend-only, backend-only)
- **š Instant PR URLs** - Generate GitHub/GitLab pull request links
š **[Explore Advanced Features](docs/ADVANCED.md)** with detailed examples and use cases.
## š ROI for Development Teams
**For a team of 10 developers:**
- **Time saved per developer**: 2 hours/day
- **Monthly team savings**: 400 hours
- **Annual value**: $200,000+ (at $100/hour)
- **Coordination errors**: Reduced to zero
- **Context switching**: Eliminated
**MultiFlow pays for itself in the first week of use.**
## šØ Perfect For
- **Microservices Architecture** - Frontend, backend, database repos (50M+ developers)
- **Mobile Development** - iOS, Android, shared components
- **Full-Stack Projects** - Web app, API, documentation
- **Enterprise Teams** - Multiple services, shared libraries (Every Fortune 500)
- **Open Source Projects** - Core, plugins, examples
- **Remote Teams** - Better coordination across distributed codebases
## š Documentation
- š **[Getting Started Guide](docs/GUIDE.md)** - Step-by-step tutorials
- š **[All Commands](docs/COMMANDS.md)** - Complete command reference
- š **[Advanced Usage](docs/ADVANCED.md)** - Power user features
- š¼ **[Corporate Setup](docs/CORPORATE-INSTALL.md)** - Restricted environments & firewalls
- ā **[FAQ](docs/FAQ.md)** - Common questions and troubleshooting
## š§ Requirements
- **Node.js 16+** (Check with `node --version`)
- **Git repositories** with at least one commit each
## š¤ Support
- š **Found a bug?** [Report it here](https://github.com/arunprabusiva/multiflow-cli/issues)
- š” **Have an idea?** [Share it here](https://github.com/arunprabusiva/multiflow-cli/discussions)
- š§ **Need help?** Check our [FAQ](docs/FAQ.md) first
## šØāš» Created By
**Arunprabu Sivapprakasam**
- š GitHub: [@arunprabusiva](https://github.com/arunprabusiva)
- š¼ LinkedIn: [Connect with me](https://linkedin.com/in/arunprabusiva)
## š License
MIT Ā© [Arunprabu Sivapprakasam](https://github.com/arunprabusiva)
---
<div align="center">
**ā Star this repo if MultiFlow saves you time!**
*Transforming how 50M+ developers work with multi-repo projects*
**Join the revolution: One command, all repositories, zero hassle.**
</div>