Quick Start¶

The quick_start.py script is a simple way to start using FRIDAY AGENT. Here’s a breakdown of what the script does and how to run it:

Importing Modules:

The script begins by importing necessary modules from the oscopilot package:

from oscopilot import FridayAgent
from oscopilot import ToolManager
from oscopilot import FridayExecutor, FridayPlanner, FridayRetriever
from oscopilot.utils import setup_config, setup_pre_run

Setting Up Configuration:

Next, the script sets up the configuration for running a task:
```
args = setup_config()
args.query = "Create a new folder named 'test_friday'"
```
This sets a query for the FRIDAY AGENT to execute, which in this case is creating a new folder named ‘test_friday’.
Preparing and Running the Task:

After configuring the task, the script prepares it for execution and runs it:
```
task = setup_pre_run(args)
agent = FridayAgent(FridayPlanner, FridayRetriever, FridayExecutor, ToolManager, config=args)
agent.run(task)
```
This initializes the FRIDAY AGENT with specified planners, retrievers, and executors, then executes the task.

Running the Script¶

To run the quick_start.py script, simply execute the following command in your terminal:

python quick_start.py

Ensure that you are in the same directory as the quick_start.py file or provide the full path to the file.

Congratulations! You have now successfully run a task with FRIDAY~