Machai is a multi-module toolkit for GenAI-enabled developer automation. It provides Java libraries and Maven tooling that unify access to multiple GenAI providers, generate and consume Bindex metadata for library discovery and reuse, and automate repository-scale documentation updates from embedded guidance using Ghostwriter.
| Module | Description |
|---|---|
| Project Layout | Utility library for describing and working with conventional project directory layouts in a consistent way across tools and plugins. |
| GenAI Client | Java library for provider-agnostic integration with Generative AI services, including prompts, tools, file inputs, and embeddings. |
| Bindex Core | Core library for Bindex metadata generation, registration, semantic library selection, and project assembly workflows. |
| Ghostwriter | Guidance-driven documentation and repository automation engine for scanning files, applying embedded guidance, and writing AI-assisted updates. |
| GW Maven Plugin | Maven plugin that integrates Ghostwriter workflows into Maven builds for guided and act-based automation. |
- Git
- Java 17 recommended for building the full project
- Maven 3.8.1 or later
git clone https://github.com/machanism-org/machai.git
cd machai
mvn -U clean installTo build and stage the Maven Site:
mvn clean install site site:stagemvn -pl genai-client clean installcd ghostwriter
mvn -Ppack package
java -jar target\gw.jar src\site\markdownGuided processing:
mvn org.machanism.machai:gw-maven-plugin:1.1.0-SNAPSHOT:gw -Dgw.scanDir=src\siteAct mode:
mvn org.machanism.machai:gw-maven-plugin:1.1.0-SNAPSHOT:act -Dgw.act="Rewrite headings for clarity" -Dgw.scanDir=src\siteAdd the required module as a Maven dependency and use it for project layout handling, GenAI integration, Bindex workflows, or guided repository automation.
- Follow the existing code style and conventions used in the repository.
- Keep changes focused and include tests where applicable.
- Use GitHub Issues for bug reports and feature requests: https://github.com/machanism-org/machai/issues
- Submit pull requests with a clear description, rationale, and reproduction details when fixing bugs.
- Review generated documentation and site changes before submitting a pull request.
Licensed under the Apache License, Version 2.0. See LICENSE.txt.
- Website: https://machai.machanism.org
- Source repository: https://github.com/machanism-org/machai
- Issue tracker: https://github.com/machanism-org/machai/issues
- Maintainer: Viktor Tovstyi (viktor.tovstyi@gmail.com)
