Skip to main content

Multi-Agent Collaboration CLI with flock-based locking and event-driven workflow

Project description

Mai CLI

English | 简体中文

PyPI Version License Python

Multi-Agent Coordination CLI — enables multiple AI agents to collaborate autonomously via a standardized command interface, backed by flock-based atomic locking.


✨ Features

  • 🔒 Atomic flock locks — race-condition-free claim/complete via POSIX fcntl.flock()
  • 📋 Standardized commands — full Issue lifecycle, queue scanning, lock management, audit logs, daily summaries
  • 📁 Dual-layer storage.mai/ as internal source, async/ as human-readable mirror
  • ⚙️ JSON configuration — queue SLA, agent heartbeat, issue ID prefix all in config.json
  • 🔄 Concurrent-safe daily summaries — multiple agents write simultaneously with flock protection
  • 🌍 Global Infrastructure — centralized management of global config and project registry in ~/.mai-cli/ (v1.10.3+)
  • Idempotent writes — repeating any operation preserves state
  • 📦 Zero dependencies — Python 3 stdlib only

🏗️ Architecture

flowchart TB
    subgraph Storage
        A[".mai/ — internal source"]
        B["async/ — human-readable mirror"]
    end
    subgraph Core
        C["Issue Queue"]
        D["flock Lock"]
        E["Heartbeat Guardian"]
    end
    subgraph Commands
        F["mai issue"]
        G["mai queue"]
        H["mai lock"]
        I["mai daily-summary"]
    end
    F --> C
    G --> C
    H --> D
    I --> C
    C --> A
    A --> B

🚀 Quick Start

Requirements

  • Python 3.8+ (stdlib only, no external dependencies)
  • Linux / macOS / WSL (POSIX environment)

Install

pip install mai-cli

Minimal Example

# 0. Global setup (v1.10.3+)
mai setup --root admin

# 1. Initialize project (Root required)
mai init -o admin

# 2. Register an agent
mai agent add alice --heartbeat-minutes 30

# 3. Create an issue

mai issue new questions "Technical review" -o alice

# 4. Claim issue (auto-locks)
mai issue claim REQ-001 -o alice

# 5. Complete issue
mai issue complete REQ-001 "Approved for implementation" -o alice

# 6. Check queue
mai queue check --overdue

📖 Documentation

Document Description
Deployment Deployment guide
Command Reference Full command reference

🤝 Contributing

PRs and Issues are welcome!

  1. Fork this project
  2. Create a feature branch git checkout -b feature/AmazingFeature
  3. Commit your changes git commit -m 'feat: Add some AmazingFeature'
  4. Push to the branch git push origin feature/AmazingFeature
  5. Open a Pull Request

📄 License

MIT License — see LICENSE.


Mai CLI v1.10.6

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mai_cli-1.11.0.tar.gz (45.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mai_cli-1.11.0-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file mai_cli-1.11.0.tar.gz.

File metadata

  • Download URL: mai_cli-1.11.0.tar.gz
  • Upload date:
  • Size: 45.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for mai_cli-1.11.0.tar.gz
Algorithm Hash digest
SHA256 108db7cc7a2d5f0eba705fa6f4e1a099d4b15f6e6b110f3c82696f6d74af9921
MD5 1275d099ecc6d427546fa2a18e1c6415
BLAKE2b-256 9052a45199502173410645736ebf517b82b3a694d65472fbd28b87bf26fc74ac

See more details on using hashes here.

File details

Details for the file mai_cli-1.11.0-py3-none-any.whl.

File metadata

  • Download URL: mai_cli-1.11.0-py3-none-any.whl
  • Upload date:
  • Size: 40.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for mai_cli-1.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6558be12970ca036813298dcc37f81f5b3f632c5cad6e18cf92ee379b785943e
MD5 8b87a2c7afd4e434f1890dced63e3ee1
BLAKE2b-256 494cdc19a1e7b7206c9b412f748454f7e8eb4f24f94528a2b463b49272ee0fe2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page