Package org.machanism.machai.cli
package org.machanism.machai.cli
Provides CLI (Command Line Interface) tools and shell commands for interacting
with GenAI-powered automation, project assembly, bindex management, library selection,
and document processing in Machai applications.
The classes in this package enable users and integrations to:
- Pick libraries and assemble projects via GenAI (see
AssembyCommand). - Generate and register bindex files (
BindexCommand). - Clean up Machai temporary directories (
CleanCommand). - Scan and process documents leveraging GenAI models (
ProcessCommand). - Bootstrap and run the CLI shell application (
MachaiCLI).
- All public and protected classes, interfaces, methods, and fields must have comprehensive Javadoc.
- Parameters, return values, and exceptions must be clearly described using
@param,@return,@throwstags. - Usage examples are provided via
<pre>blocks in Javadoc. - Javadoc should be updated together with any code change.
- Use consistent formatting and escape < and > in
<pre>blocks. - Use IDE/static analysis tools to ensure completeness of Javadoc.
- Refer to
pom.xmlfor the Java version required for all code.
- Since:
- 0.0.2
- Author:
- Viktor Tovstyi
-
ClassesClassDescriptionShell command for application assembly and library picking operations via GenAI.Shell command for creating and registering Bindex files using GenAI.Provides shell commands for cleaning up Machai temporary folders.Main entry point for the Machai CLI application.Shell command for GenAI document processing operations.