phantomaton-execution v0.0.5

Phantomaton Execution ⚙️

The Phantomaton Execution module is a plugin for the Phantomaton AI framework. It provides a robust and extensible infrastructure for registering and executing commands within the Phantomaton conversational ecosystem.

Purpose 🎯

Phantomaton is designed to be a highly interactive and responsive AI assistant, capable of performing a variety of tasks beyond just conversing. The Phantomaton Execution plugin enables this by allowing developers to register executable commands that can be invoked by the LLM-powered Assistant.

When a registered command is detected in the user's input, the Phantomaton Execution plugin will execute the corresponding command and prepend the result to the Assistant's response. This allows the Phantomaton system to seamlessly integrate task-oriented functionality directly into the conversational flow.

Features 🔧

• Command Registration: Developers can register commands using the Phantomaton Plugins framework, providing a simple and extensible way to add new capabilities.
• Command Documentation: Registered commands are automatically documented using the Necronomicon specification, making it easy for users to discover and utilize the available functionality.
• Preamble Injection: The results of executed commands are prepended to the Assistant's responses, maintaining the conversational context and flow.
• Sandboxing: Command execution is performed in a secure sandbox, preventing harmful or unintended behavior from affecting the broader Phantomaton system.

Usage 🛠️

To use the Phantomaton Execution plugin, you'll need to install it as a dependency in your Phantomaton-based application:

npm install phantomaton-execution

Registering Commands

You can register multiple commands by calling plugin.define(execution.command) multiple times. This leverages the Phantomaton Plugins system to create extensible command definitions that follow the Necronomicon specification:

import execution from 'phantomaton-execution';
import plugins from 'phantomaton-plugins';

export default plugins.create([
  // Register first command
  plugins.define(execution.command).as({
    name: 'capitalize',
    validate: (attributes) => !!attributes.text,
    execute: (attributes) => attributes.text.toUpperCase(),
    example: { attributes: { text: 'Test' } },
    description: 'Capitalizes text'
  }),

  // Register another command
  plugins.define(execution.command).as({
    name: 'reverse',
    validate: (attributes) => !!attributes.text,
    execute: (attributes) => attributes.text.split('').reverse().join(''),
    example: { attributes: { text: 'hello' } },
    description: 'Reverses text'
  })
])

Contributing 🤝

We welcome contributions to the Phantomaton Execution project! If you have any ideas, bug reports, or pull requests, please feel free to submit them on the Phantomaton Execution GitHub repository.

License 📜

The Phantomaton Execution module is licensed under the MIT License.