phantomaton-system v1.0.0

Phantomaton System 🤖

The Phantomaton System is a module that provides an extension point for generating a unified system prompt in Phantomaton applications.

Usage 🛠️

The Phantomaton System exposes a plugin.system extension point that can be used to generate a system prompt for your Phantomaton application. This extension point can be installed and used within the Phantomaton project.

The system prompt is composed of three parts:

1. The user input, which is retrieved from the input symbol provided by the priestess module.
2. Any additional system prompt providers that have been registered.
3. The aggregation of all the system prompt providers.

Here's an example of how to use the Phantomaton System:

import hierophant from 'hierophant';
import plugin from 'phantomaton-system';

const container = hierophant();

// Install the Phantomaton System plugin
plugin().install.forEach(c => container.install(c));

// Register an additional system prompt provider
container.install(plugin.system.provider([], () => 'Additional prompt information'));

// Resolve the system prompt and use it in your application
const [getSystemPrompt] = container.resolve(plugin.system.resolve);
const systemPrompt = getSystemPrompt();
console.log(systemPrompt);

For more information on how to use the Phantomaton System, please refer to the Phantomaton project documentation.

Extending the System 🔧

The Phantomaton System is designed to be extensible. You can register additional system prompt providers by installing them in the hierophant container, and they will be automatically aggregated into the final system prompt.

Contributing 🦄

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

License 🔒

The Phantomaton System is licensed under the MIT License.