Class Shell

java.lang.Object

uno.anahata.asi.agi.tool.ToolContext

uno.anahata.asi.agi.tool.AnahataToolkit

uno.anahata.asi.toolkit.shell.Shell

All Implemented Interfaces:

ContextProvider, PropertyChangeSource, Rebindable

public class Shell
extends AnahataToolkit

A tool provider that allows the AI model to execute commands in the local shell. It supports Bash (Unix), CMD (Windows), and PowerShell (Windows).

This tool is powerful and should be used with caution. It captures standard output, standard error, and execution metadata.

Author:

anahata

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Shell.ShellType	Defines the supported shell types.
private class	Shell.StreamGobbler	A background task that consumes an InputStream and forwards its content to the tool's log or error stream.

Field Summary

Fields inherited from class AnahataToolkit

childrenProviders, propertyChangeSupport

Modifier and Type	Field	Description
protected List<ContextProvider>	childrenProviders	The list of child context providers managed by this toolkit.
protected PropertyChangeSupport	propertyChangeSupport	Support for firing property change events.

Fields inherited from class ToolContext

toolkit

Modifier and Type	Field	Description
protected JavaObjectToolkit	toolkit	The toolkit instance that owns this context.

Constructor Summary

Constructors

Constructor	Description
Shell()

Method Summary

Modifier and Type	Method	Description
void	populateMessage(RagMessage ragMessage)	Populates the given RagMessage with dynamic, just-in-time context parts.
ShellExecutionResult	runAndWait(String command, Shell.ShellType type, String workingDirectory)	Executes a shell command using the appropriate system shell.

Methods inherited from class AnahataToolkit

getChildrenProviders, getDescription, getId, getName, getParentProvider, getPropertyChangeSupport, initialize, isEffectivelyProviding, postActivate, rebind

Modifier and Type	Method	Description
List<ContextProvider>	getChildrenProviders()	Gets the list of immediate child context providers.
String	getDescription()	Gets a detailed description of what this context provider does.
String	getId()	Gets the unique identifier for this context provider.
String	getName()	Gets the human-readable name of this context provider.
ContextProvider	getParentProvider()	Gets the parent context provider in the hierarchy, if any.
PropertyChangeSupport	getPropertyChangeSupport()	Gets the PropertyChangeSupport instance for this object.
void	initialize()	Performs initial setup for a newly created toolkit instance.
boolean	isEffectivelyProviding()	Override to also take into consideration the AbstractToolkit.enabled
void	postActivate()	Callback method triggered by the Asi Container once the Agi session has been fully deserialized and associated to the ASI container.
void	rebind()	Rebinds the toolkit after deserialization.

Methods inherited from class ToolContext

addAttachment, addAttachment, addAttachment, addAttachment, error, error, error, getAgi, getApplicationMap, getAsiContainer, getAsiContainerMap, getCall, getExecutorService, getModelId, getModelMessage, getResourceManager, getResponse, getSessionMap, getThreadSafeLogger, getTool, getToolContext, getToolkit, getToolManager, getTurnMap, isToolExecution, log, peekResponse, runAsync

Modifier and Type	Method	Description
void	addAttachment(byte[] data, String mimeType)	Attaches a binary blob to the current tool's response.
void	addAttachment(byte[] data, String mimeType, Path sourcePath)	Attaches a binary blob to the current tool's response with source file path traceability.
void	addAttachment(File file)	Convenience method to attach a file to the current tool's response.
void	addAttachment(Path path)	Convenience method to attach a file from a Path to the current tool's response.
void	error(String message)	Adds an error message to the current tool's response.
void	error(String message, Throwable t)	Adds an error message and exception stack trace to the current tool's response.
void	error(Throwable t)	Adds an exceptions stack trace to the current tool's response.
Agi	getAgi()	Convenience method to get the parent agi container for the current execution.
Map	getApplicationMap()	Gets a static, application-scoped map for sharing objects across all containers in the current JVM.
AbstractAsiContainer	getAsiContainer()	Gets the current ASI container hosting this Agi container is running.
Map	getAsiContainerMap()	Gets a map for sharing objects across all sessions within the current ASI container.
JavaMethodToolCall	getCall()	Convenience method to get the current tool call that initiated this execution.
ExecutorService	getExecutorService()	Convenience method to get the executor service for the current agi session.
String	getModelId()	The id of model that is executing the tool.
AbstractModelMessage	getModelMessage()	The id of model that is executing the tool.
ResourceManager	getResourceManager()	Convenience method to get the application's ResourceManager.
JavaMethodToolResponse	getResponse()	Gets the current tool response from the thread-local context.
Map	getSessionMap()	Gets a shared map for storing state across turns within the current agi session.
Consumer<String>	getThreadSafeLogger()	Gets a thread-safe logging consumer that automatically propagates the current tool execution context whenever a message is logged.
JavaMethodTool	getTool()	Convenience method to get the metadata for the tool currently being executed.
ToolContext	getToolContext()	Returns a thread-safe snapshot of this context.
<T> T	getToolkit(Class<T> toolkitClass)	Retrieves the singleton instance of a registered toolkit class.
ToolManager	getToolManager()	Convenience method to get the application's global ToolManager.
Map	getTurnMap()	Gets a shared map for storing state across turns within the current agi session.
boolean	isToolExecution()	Checks if the current thread or this context instance is associated with an active tool execution.
void	log(String message)	Adds a standard log message to the current tool's response.
protected JavaMethodToolResponse	peekResponse()	Internal helper to retrieve the response if it exists, without throwing an exception.
void	runAsync(String taskName, Runnable task)	Executes a task asynchronously in the session's executor service, automatically propagating the current tool execution context to the background thread.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ContextProvider

getAgi, getContextPosition, getFlattenedHierarchy, getFullyQualifiedId, getHeader, getIconId, getInstructionsTokenCount, getRagTokenCount, getSystemInstructions, isProviding, setParentProvider, setProviding

Modifier and Type	Method	Description
Agi	getAgi()	Gets the parent AGI session this context provider is registered under.
default ContextPosition	getContextPosition()	Gets the designated position of this provider's content in the AI prompt.
default List<ContextProvider>	getFlattenedHierarchy(boolean providingOnly)	Gets a flattened list of this provider and all its descendants in the hierarchy.
default String	getFullyQualifiedId()	Gets the fully qualified ID of this provider, reflecting its position in the hierarchy.
default String	getHeader()	Generates a machine-readable header string for this context provider, used to identify the source of injected context in the final prompt.
default String	getIconId()	Gets an optional icon identifier for this provider.
default int	getInstructionsTokenCount()	Calculates the token count for the system instructions provided by this instance using the active model.
default int	getRagTokenCount()	Calculates the token count for the RAG content provided by this instance using the active model.
default List<String>	getSystemInstructions()	Gets a list of system instruction strings provided by this context provider.
boolean	isProviding()	Checks if this context provider is currently active and providing context.
default void	setParentProvider(ContextProvider parent)	Sets the parent context provider for this instance.
default void	setProviding(boolean enabled)	Sets whether this context provider is enabled.

Constructor Details

Shell

public Shell()

Method Details

populateMessage

public void populateMessage(RagMessage ragMessage)
                     throws Exception

Populates the given RagMessage with dynamic, just-in-time context parts. These parts are appended to the end of the user's prompt (RAG).

Parameters:

ragMessage - The message to be augmented with context.

Throws:

Exception - if an error occurs during context generation.

runAndWait

public ShellExecutionResult runAndWait(String command,
 Shell.ShellType type,
 String workingDirectory)
                                throws Exception

Executes a shell command using the appropriate system shell.

Parameters:

command - The shell command to execute.

type - The type of shell to use. If null, it

workingDirectory - the directory in which the shell command will be executed.

Returns:

A ShellExecutionResult containing the exit code and output.

Throws:

Exception - if the command fails to start or execution is interrupted.