← Back to Plugins
Integration

Project Workflow

FraN-arti By FraN-arti 👁 249 views ▲ 0 votes

Advanced project workflow plugin for OpenClaw - smart code analysis, git integration, and GitHub automation

GitHub

Install

npm install

#

Configuration Example

{
  "plugins": {
    "entries": {
      "project-workflow": {
        "enabled": true,
        "config": {
          "autoAnalyze": true,
          "gitIntegration": true,
          "githubIntegration": true
        }
      }
    }
  }
}

README

# Project Workflow Plugin

<div align="center">

[![OpenClaw](https://img.shields.io/badge/OpenClaw-2026.4.5-blue?style=flat-square&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBkPSJNMTIgMkw0IDZWMTJDNCAyMC41IDEyIDIyIDEyIDIyQzEyIDIyIDIwIDIwLjUgMjAgMTJWNkwxMiAyWiIgZmlsbD0iI2ZmZmZmZiIvPjwvc3ZnPg==)](https://openclaw.ai)
[![Composio](https://img.shields.io/badge/Composio-Integration-green?style=flat-square&logo=github)](https://composio.dev)
[![License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)](LICENSE)

### **Stop repeating yourself.**

Automate your AI agent for seamless GitHub workflow. Stay on top of bugs, track completed work, and let your agent handle git history, code analysis, dependency checks, and PR management โ€” all automatically.

</div>

---

## ๐Ÿ™ Built With

This plugin is powered by amazing open-source projects:

- **[OpenClaw](https://openclaw.ai)** โ€” The AI assistant framework that makes this plugin possible
- **[Composio](https://composio.dev)** โ€” Seamless GitHub integration and 1000+ tool connections

Special thanks to the OpenClaw and Composio communities for building incredible tools! ๐Ÿš€

---

## โš™๏ธ Requirements

### Required
- **Git** โ€” Must be installed and available in PATH for local git features (history, blame, commits)
- **Node.js 22+** โ€” Required for OpenClaw

### Optional
- **[Composio](https://composio.dev)** โ€” For GitHub integration (PRs, issues, remote repository analysis)
  - Without Composio: All local features work (git history, code analysis, dependency checks)
  - With Composio: Full GitHub automation (push, PR creation, issue tracking)

**Check if Git is installed:**
```bash
git --version
```

If not installed, download from [git-scm.com](https://git-scm.com/downloads)

---

## How It Works

### ๐Ÿ”ง Hybrid Approach: Local + Remote

This plugin uses a **hybrid approach** for maximum flexibility:

#### **Local Git (Always Available)**
- โœ… Works **without internet**
- โœ… Works **without GitHub**
- โœ… Analyzes your local repository
- โœ… Creates commits **locally** (on your computer)

**What is a "local commit"?**
> A local commit saves your changes in git on your computer, but **does NOT send them to GitHub yet**.
> 
> Think of it like writing a letter and putting it in an envelope โ€” it's ready to send, but still in your hands.
> 
> You decide when to push (send) it to GitHub.

#### **GitHub Integration (Optional, via Composio)**
- ๐Ÿ”„ Requires [Composio](https://composio.dev) setup
- ๐Ÿ”„ Analyzes remote PRs, issues, commits
- ๐Ÿ”„ Can push commits to GitHub
- ๐Ÿ”„ Can create PRs automatically

**The plugin automatically detects:**
- โœ… Is git available? โ†’ Enables git features
- โœ… Is there a remote repository? โ†’ Offers to push
- โœ… Is Composio connected? โ†’ Enables GitHub features

### ๐Ÿ“‹ Typical Workflow

```
You: "Add authentication to the API"

Plugin automatically:
1. โœ… Analyzes local git history
2. โœ… Finds related files
3. โœ… Checks dependencies
4. โœ… Makes changes
5. โœ… Creates commit locally: "feat(auth): add JWT authentication"

Agent asks:
"Changes ready! Detected remote: github.com/you/project
Composio connected โœ…

What do you want to do?
1. Push to main
2. Create branch feature/auth and PR
3. Keep local only"

You choose โ†’ Plugin executes
```

### ๐ŸŽฏ What You Get

**Without Composio (Local Only):**
- Git history analysis
- Code structure analysis
- Smart commits with detailed messages
- Dependency checking

**With Composio (Local + GitHub):**
- Everything above, PLUS:
- Push to GitHub
- Create PRs with auto-generated descriptions
- Analyze existing PRs/issues
- Link commits to issues

---

## Features

### ๐Ÿ” Smart Code Analysis
- **`project_analyze_codebase`** โ€” Analyze project structure, dependencies, and architecture
- **`project_gather_context`** โ€” Automatically find all related files for a task
  - Keyword-based file search using Node.js fs API
  - Cross-platform support (Windows, Linux, macOS)
  - No external dependencies required

### ๐Ÿ“Š Git Integration
- **`project_git_history`** โ€” Analyze git history (like codemaps) - who changed what and when
- Git blame integration
- Commit history analysis

### ๐Ÿ”— GitHub Integration (via Composio)
- **`project_github_analyze`** โ€” Analyze PRs, issues, commits
- Automatic PR/issue linking
- Code review automation

### โšก Smart Hooks
- **Auto-analysis before code changes** โ€” Automatically gathers context before `edit`/`write`
- **Smart commit suggestions** โ€” Generates meaningful commit messages
- **Integration checks** โ€” Warns about potential breaking changes

## Installation

```bash
# From workspace directory
cd openclaw-project-workflow
npm install

# Install in OpenClaw
openclaw plugins install ./openclaw-project-workflow
```

## Configuration

Add to `~/.openclaw/openclaw.json`:

```json
{
  "plugins": {
    "entries": {
      "project-workflow": {
        "enabled": true,
        "config": {
          "autoAnalyze": true,
          "gitIntegration": true,
          "githubIntegration": true
        }
      }
    }
  }
}
```

## Usage

### Analyze Codebase
```
project_analyze_codebase({ projectPath: "./my-project" })
```

### Check Git History
```
project_git_history({ filePath: "src/main.ts", since: "2 weeks ago" })
```

### Gather Context
```
project_gather_context({ task: "Add authentication to API" })
```

### Analyze GitHub
```
project_github_analyze({ repo: "owner/repo", type: "pr", limit: 10 })
```

## Workflow

1. **You give a task** โ†’ Plugin gathers context automatically
2. **Analysis runs** โ†’ Git history, dependencies, related files
3. **Changes made** โ†’ Integration checks run
4. **Commit suggested** โ†’ Smart commit message generated

## Development Status

โœ… **Ready to Use** โ€” All 5 core tools implemented and tested.

**Implemented:**
- โœ… Git history analysis (`project_git_history`)
- โœ… Context gathering with fallback (`project_gather_context`)
- โœ… Integration checks (`project_check_integration`)
- โœ… Codebase analysis (`project_analyze_codebase`)
- โœ… GitHub integration via Composio (`project_github_analyze`)

**Roadmap:**
- ๐Ÿ”„ Smart hooks (before/after tool calls)
- ๐Ÿ”„ Automated testing
- ๐Ÿ”„ Plugin marketplace publication

## License

MIT
integration

Comments

Sign in to leave a comment

Loading comments...