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.0+)
  • 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

# 1. Initialize project
mai init

# 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.9.2

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.10.0.tar.gz (42.4 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.10.0-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mai_cli-1.10.0.tar.gz
  • Upload date:
  • Size: 42.4 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.10.0.tar.gz
Algorithm Hash digest
SHA256 7c5c9e9f07afd21956274027af21ad345a7b5ae9e2641ef18a23db7915aebe34
MD5 caddb821788493601f76ddeb3f44b6f6
BLAKE2b-256 3cfd0147d633724b1109cb722b1a4e0e7b52031157992aaf831ab9e0927ae796

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mai_cli-1.10.0-py3-none-any.whl
  • Upload date:
  • Size: 39.3 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.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39290345f0729734f43908c806c17dddc1608a1fbdfb7dfd8dc5aee98d0be539
MD5 caee140b42e2db8838a721d31a849f9c
BLAKE2b-256 373ef7e6fe86f2df30811507cf794aeafb2b844905b15791746e1e8d5d12f8e0

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