npcsh 0.3.25__py3-none-any.whl → 0.3.26__py3-none-any.whl

{npcsh-0.3.25.dist-info → npcsh-0.3.26.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: npcsh
-Version: 0.3.25
+Version: 0.3.26
 Summary: npcsh is a command line tool for integrating LLMs into everyday workflows and for orchestrating teams of NPCs.
 Home-page: https://github.com/cagostino/npcsh
 Author: Christopher Agostino
@@ -27,7 +27,6 @@ Requires-Dist: opencv-python
 Requires-Dist: librosa
 Requires-Dist: openai
 Requires-Dist: jinja2
-Requires-Dist: pyautogui
 Requires-Dist: pandas
 Requires-Dist: matplotlib
 Requires-Dist: IPython
@@ -37,14 +36,11 @@ Requires-Dist: markdown
 Requires-Dist: PyYAML
 Requires-Dist: langchain
 Requires-Dist: langchain_community
-Requires-Dist: openai-whisper
-Requires-Dist: pyaudio
+Requires-Dist: pyautogui
 Requires-Dist: pygments
 Requires-Dist: pyttsx3
 Requires-Dist: kuzu
 Requires-Dist: chromadb
-Requires-Dist: gtts
-Requires-Dist: playsound==1.2.2
 Requires-Dist: termcolor
 Requires-Dist: colorama
 Requires-Dist: python-dotenv
@@ -72,7 +68,7 @@ Dynamic: summary
 # npcsh
 
 
-- `npcsh` is a python-based command-line tool designed to integrate Large Language Models (LLMs) and Agents into one's daily workflow by making them available and easily configurable through the command line shell.
+- `npcsh` is a python-based AI Agent framework designed to integrate Large Language Models (LLMs) and Agents into one's daily workflow by making them available and easily configurable through a command line shell as well as an extensible python library.
 
 - **Smart Interpreter**: `npcsh` leverages the power of LLMs to understand your natural language commands and questions, executing tasks, answering queries, and providing relevant information from local files and the web.
 
@@ -83,10 +79,9 @@ Dynamic: summary
 
 * **Extensible with Python:**  `npcsh`'s python package provides useful functions for interacting with LLMs, including explicit coverage for popular providers like ollama, anthropic, openai, gemini, deepseek, and openai-like providers. Each macro has a corresponding function and these can be used in python scripts. `npcsh`'s functions are purpose-built to simplify NPC interactions but NPCs are not required for them to work if you don't see the need.
 
-* **Simple, Powerful CLI:**  Use the `npc` CLI commands to set up a flask server so you can expose your NPC team for use as a backend service. You can also use the `npc` CLI to run SQL models defined in your project, execute assembly lines, and verify the integrity of your NPC team's interrelations. `npcsh`'s NPCs take advantage of jinja templating to reference other NPCs and tools in their properties, and the `npc` CLI can be used to verify these references.
-
-* **Shell Strengths:** Execute bash commands directly. Use your favorite command-line tools like VIM, Emacs, ipython, sqlite3, git. Pipe the output of these commands to LLMs or pass LLM results to bash commands.
+* **Simple, Powerful CLI:**  Use the `npc` CLI commands to run `npcsh` macros or commands from one's regular shell. Set up a flask server so you can expose your NPC team for use as a backend service. You can also use the `npc` CLI to run SQL models defined in your project, execute assembly lines, and verify the integrity of your NPC team's interrelations. `npcsh`'s NPCs take advantage of jinja templating to reference other NPCs and tools in their properties, and the `npc` CLI can be used to verify these references.
 
+* **Powerful Tool integrations:** `npcsh` has built-in tools for users to have agents execute code, analyze data, generate images, search the web, and more. Tools can be defined in YAML files as part of project-specific `npc_team`s or in the global `~/.npcsh/npc_team` directory or simply in python scripts. Once compiled, the tools can be used as macros in the `npc` cli as well as `/{tool_name}` commands in the `npcsh` shell.
 
 
 Interested to stay in the loop and to hear the latest and greatest about `npcsh` ? Be sure to sign up for the [npcsh newsletter](https://forms.gle/n1NzQmwjsV4xv1B2A)!
@@ -113,1625 +108,1635 @@ Users can take advantage of `npcsh` through its custom shell or through a comman
 | Voice Chat    | npc whisper 'npc_name'   | /whisper   |
 
 
-## Star History
+## Python Examples
+Integrate npcsh into your Python projects for additional flexibility. Below are a few examples of how to use the library programmatically.
 
-[![Star History Chart](https://api.star-history.com/svg?repos=cagostino/npcsh&type=Date)](https://star-history.com/#cagostino/npcsh&Date)
 
-## Installation
-`npcsh` is available on PyPI and can be installed using pip. Before installing, make sure you have the necessary dependencies installed on your system. Below are the instructions for installing such dependencies on Linux, Mac, and Windows. If you find any other dependencies that are needed, please let us know so we can update the installation instructions to be more accommodating.
 
-### Linux install
+### Example 1: Creating and Using an NPC
+This example shows how to create and initialize an NPC and use it to answer a question.
 ```bash
+import sqlite3
+from npcsh.npc_compiler import NPC
 
-sudo apt-get install espeak
-sudo apt-get install portaudio19-dev python3-pyaudio
-sudo apt-get install alsa-base alsa-utils
-sudo apt-get install libcairo2-dev
-sudo apt-get install libgirepository1.0-dev
-sudo apt-get install ffmpeg
+# Set up database connection
+db_path = '~/npcsh_history.db'
+conn = sqlite3.connect(db_path)
 
-#And if you don't have ollama installed, use this:
-curl -fsSL https://ollama.com/install.sh | sh
+# Load NPC from a file
+npc = NPC(
+          name='Simon Bolivar',
+          db_conn=conn,
+          primary_directive='Liberate South America from the Spanish Royalists.',
+          model='gpt-4o-mini',
+          provider='openai',
+          )
 
-ollama pull llama3.2
-ollama pull llava:7b
-ollama pull nomic-embed-text
-pip install npcsh
+response = npc.get_llm_response("What is the most important territory to retain in the Andes mountains?")
+print(response['response'])
+```
+```bash
+'The most important territory to retain in the Andes mountains for the cause of liberation in South America would be the region of Quito in present-day Ecuador. This area is strategically significant due to its location and access to key trade routes. It also acts as a vital link between the northern and southern parts of the continent, influencing both military movements and the morale of the independence struggle. Retaining control over Quito would bolster efforts to unite various factions in the fight against Spanish colonial rule across the Andean states.'
 ```
+### Example 2: Using an NPC to Analyze Data
+This example shows how to use an NPC to perform data analysis on a DataFrame using LLM commands.
+```bash
+from npcsh.npc_compiler import NPC
+import sqlite3
+import os
+# Set up database connection
+db_path = '~/npcsh_history.db'
+conn = sqlite3.connect(os.path.expanduser(db_path))
 
+# make a table to put into npcsh_history.db or change this example to use an existing table in a database you have
+import pandas as pd
+data = {
+        'customer_feedback': ['The product is great!', 'The service was terrible.', 'I love the new feature.'],
+        'customer_id': [1, 2, 3],
+        'customer_rating': [5, 1, 3],
+        'timestamp': ['2022-01-01', '2022-01-02', '2022-01-03']
+        }
 
 
+df = pd.DataFrame(data)
+df.to_sql('customer_feedback', conn, if_exists='replace', index=False)
 
-### Mac install
-```bash
-brew install portaudio
-brew install ffmpeg
-brew install ollama
-brew services start ollama
-brew install pygobject3
-ollama pull llama3.2
-ollama pull llava:7b
-ollama pull nomic-embed-text
-pip install npcsh
-```
-### Windows Install
 
-Download and install ollama exe.
+npc = NPC(
+          name='Felix',
+          db_conn=conn,
+          primary_directive='Analyze customer feedback for sentiment.',
+          model='gpt-4o-mini',
+          provider='openai',
+          )
+response = npc.analyze_db_data('Provide a detailed report on the data contained in the `customer_feedback` table?')
 
-Then, in a powershell. Download and install ffmpeg.
 
 ```
-ollama pull llama3.2
-ollama pull llava:7b
-ollama pull nomic-embed-text
-pip install npcsh
-```
-As of now, npcsh appears to work well with some of the core functionalities like /ots and /whisper.
 
 
-### Fedora Install (under construction)
-
-python3-dev (fixes hnswlib issues with chroma db)
-xhost +  (pyautogui)
-python-tkinter (pyautogui)
+### Example 3: Creating and Using a Tool
+You can define a tool and execute it from within your Python script.
+Here we'll create a tool that will take in a pdf file, extract the text, and then answer a user request about the text.
 
-## Startup Configuration and Project Structure
-After it has been pip installed, `npcsh` can be used as a command line tool. Start it by typing:
-```bash
-npcsh
-```
-When initialized, `npcsh` will generate a .npcshrc file in your home directory that stores your npcsh settings.
-Here is an example of what the .npcshrc file might look like after this has been run.
 ```bash
-# NPCSH Configuration File
-export NPCSH_INITIALIZED=1
-export NPCSH_CHAT_PROVIDER='ollama'
-export NPCSH_CHAT_MODEL='llama3.2'
-export NPCSH_DB_PATH='~/npcsh_history.db'
-```
-`npcsh` also comes with a set of tools and NPCs that are used in processing. It will generate a folder at ~/.npcsh/ that contains the tools and NPCs that are used in the shell and these will be used in the absence of other project-specific ones. Additionally, `npcsh` records interactions and compiled information about npcs within a local SQLite database at the path specified in the .npcshrc file. This will default to ~/npcsh_history.db if not specified. When the data mode is used to load or analyze data in CSVs or PDFs, these data will be stored in the same database for future reference.
+from npcsh.npc_compiler import Tool, NPC
+import sqlite3
+import os
 
-The installer will automatically add this file to your shell config, but if it does not do so successfully for whatever reason you can add the following to your .bashrc or .zshrc:
+from jinja2 import Environment, FileSystemLoader
 
-```bash
-# Source NPCSH configuration
-if [ -f ~/.npcshrc ]; then
-    . ~/.npcshrc
-fi
-```
+# Create a proper Jinja environment
+jinja_env = Environment(loader=FileSystemLoader('.'))
 
-We support inference via `openai`, `anthropic`, `ollama`,`gemini`, `deepseek`,  and `openai-like` APIs. The default provider must be one of `['openai','anthropic','ollama', 'gemini', 'deepseek', 'openai-like']` and the model must be one available from those providers.
 
-To use tools that require API keys, create an `.env` file up in the folder where you are working or place relevant API keys as env variables in your ~/.npcshrc. If you already have these API keys set in a ~/.bashrc or a ~/.zshrc or similar files, you need not additionally add them to ~/.npcshrc or to an `.env` file. Here is an example of what an `.env` file might look like:
+tool_data = {
+    "tool_name": "pdf_analyzer",
+    "inputs": ["request", "file"],
+    "steps": [{  # Make this a list with one dict inside
+        "engine": "python",
+        "code": """
+try:
+    import fitz  # PyMuPDF
 
-```bash
-export OPENAI_API_KEY="your_openai_key"
-export ANTHROPIC_API_KEY="your_anthropic_key"
-export DEEPSEEK_API_KEY='your_deepseek_key'
-export GEMINI_API_KEY='your_gemini_key'
-export PERPLEXITY_API_KEY='your_perplexity_key'
-```
+    shared_context = {}
+    shared_context['inputs'] = '{{request}}'
 
+    pdf_path = '{{file}}'
 
- Individual npcs can also be set to use different models and providers by setting the `model` and `provider` keys in the npc files.
- Once initialized and set up, you will find the following in your ~/.npcsh directory:
-```bash
-~/.npcsh/
-├── npc_team/           # Global NPCs
-│   ├── tools/          # Global tools
-│   └── assembly_lines/ # Workflow pipelines
 
-```
-For cases where you wish to set up a project specific set of NPCs, tools, and assembly lines, add a `npc_team` directory to your project and `npcsh` should be able to pick up on its presence, like so:
-```bash
-./npc_team/            # Project-specific NPCs
-├── tools/             # Project tools #example tool next
-│   └── example.tool
-└── assembly_lines/    # Project workflows
-    └── example.pipe
-└── models/    # Project workflows
-    └── example.model
-└── example1.npc        # Example NPC
-└── example2.npc        # Example NPC
-└── example1.ctx        # Example NPC
-└── example2.ctx        # Example NPC
 
-```
+    # Open the PDF
+    doc = fitz.open(pdf_path)
+    text = ""
 
-## IMPORTANT: migrations and deprecations
+    # Extract text from each page
+    for page_num in range(len(doc)):
+        page = doc[page_num]
+        text += page.get_text()
 
-### v0.3.4
--In v0.3.4, the structure for tools was adjusted. If you have made custom tools please refer to the structure within npc_compiler to ensure that they are in the correct format. Otherwise, do the following
-```bash
-rm ~/.npcsh/npc_team/tools/*.tool
-```
-and then
-```bash
-npcsh
-```
-and the updated tools will be copied over into the correct location.
+    # Close the document
+    doc.close()
 
-### v0.3.5
--Version 0.3.5 included a complete overhaul and refactoring of the llm_funcs module. This was done to make it not as horribly long and to make it easier to add new models and providers
+    print(f"Extracted text length: {len(text)}")
+    if len(text) > 100:
+        print(f"First 100 characters: {text[:100]}...")
 
+    shared_context['extracted_text'] = text
+    print("Text extraction completed successfully")
 
--in version 0.3.5, a change was introduced to the database schema for messages to add npcs, models, providers, and associated attachments to data. If you have used `npcsh` before this version, you will need to run this migration script to update your database schema:   [migrate_conversation_history_v0.3.5.py](https://github.com/cagostino/npcsh/blob/cfb9dc226e227b3e888f3abab53585693e77f43d/npcsh/migrations/migrate_conversation_history_%3Cv0.3.4-%3Ev0.3.5.py)
+except Exception as e:
+    error_msg = f"Error processing PDF: {str(e)}"
+    print(error_msg)
+    shared_context['extracted_text'] = f"Error: {error_msg}"
+"""
+    },
+     {
+        "engine": "natural",
+        "code": """
+{% if shared_context and shared_context.extracted_text %}
+{% if shared_context.extracted_text.startswith('Error:') %}
+{{ shared_context.extracted_text }}
+{% else %}
+Here is the text extracted from the PDF:
 
--additionally, NPCSH_MODEL and NPCSH_PROVIDER have been renamed to NPCSH_CHAT_MODEL and NPCSH_CHAT_PROVIDER
-to provide a more consistent naming scheme now that we have additionally introduced `NPCSH_VISION_MODEL` and `NPCSH_VISION_PROVIDER`, `NPCSH_EMBEDDING_MODEL`, `NPCSH_EMBEDDING_PROVIDER`, `NPCSH_REASONING_MODEL`, `NPCSH_REASONING_PROVIDER`, `NPCSH_IMAGE_GEN_MODEL`, and `NPCSH_IMAGE_GEN_PROVIDER`.
-- In addition, we have added NPCSH_API_URL to better accommodate openai-like apis that require a specific url to be set as well as `NPCSH_STREAM_OUTPUT` to indicate whether or not to use streaming in one's responses. It will be set to 0 (false) by default as it has only been tested  and verified for a small subset of the models and providers we have available (openai, anthropic, and ollama). If you try it and run into issues, please post them here so we can correct them as soon as possible !
+{{ shared_context.extracted_text }}
 
+Please provide a response to user request: {{ request }} using the information extracted above.
+{% endif %}
+{% else %}
+Error: No text was extracted from the PDF.
+{% endif %}
+"""
+    },]
+    }
 
-## npcsh usage
-In the `npcsh` shell, users can ask LLMs questions, have LLMLs execute commands or use tools, or utilize macros that provide additional functionality. When a user does not invoke a specific macro, the shell will automatically decide which tool to use based on the user's input. Here are some examples of things one might ask the npcsh shell.
+# Instantiate the tool
+tool = Tool(tool_data)
 
-Here are some examples of how you can use npcsh
-```npcsh
-npcsh>Who was Simon Bolivar?
+# Create an NPC instance
+npc = NPC(
+    name='starlana',
+    primary_directive='Analyze text from Astrophysics papers with a keen attention to theoretical machinations and mechanisms.',
+    model = 'llama3.2',
+    provider='ollama',
+    db_conn=sqlite3.connect(os.path.expanduser('~/npcsh_database.db'))
+)
 
-Simón Bolívar, often referred to as "El Libertador," was a Venezuelan military and political leader who played a key role in the Latin American wars of independence against Spanish
-colonial rule in the early 19th century. He was born on July 24, 1783, in Caracas, Venezuela, into a wealthy Creole family.
-Bolívar's vision extended beyond merely liberating territories; he aspired to unify the newly independent nations of South America into a single federation, which he called "Gran
-Colombia," consisting of present-day Colombia, Venezuela, Ecuador, and Panama. He was known for his exceptional military strategies and leadership, which led to successful campaigns in
-various regions, including the battles of Boyacá, Carabobo, and Ayacucho.
-He faced numerous challenges, including political fragmentation, regional rivalries, and personal betrayals. Despite his initial successes, the unity he sought for Latin America proved
-difficult to achieve, and Gran Colombia eventually disintegrated in the early 1830s.
-Bolívar's influence and legacy extend far beyond his lifetime. He is celebrated in various countries across Latin America as a national hero and symbol of independence. His thoughts on
-liberty, governance, and social issues continue to inspire movements for democracy and social justice in the region. Simón Bolívar died on December 17, 1830, but remains a pivotal figure
-in the history of Latin America.
-```
+# Define input values dictionary
+input_values = {
+    "request": "what is the point of the yuan and narayanan work?",
+    "file": os.path.abspath("test_data/yuan2004.pdf")
+}
 
+print(f"Attempting to read file: {input_values['file']}")
+print(f"File exists: {os.path.exists(input_values['file'])}")
 
-```npcsh
-npcsh> What is the capital of France?
-The capital of France is Paris. It is the largest city in the country and is known for its rich history, art, culture, and architecture, including famous landmarks such as the Eiffel Tower, Notre-Dame Cathedral, and the Louvre Museum.
+# Execute the tool
+output = tool.execute(input_values, npc.tools_dict, jinja_env, 'Sample Command',model=npc.model, provider=npc.provider,  npc=npc)
+
+print('Tool Output:', output)
 ```
 
-```npcsh
-npcsh> can you tell me a joke about my favorite city?
+### Example 4: Orchestrating a team
 
-Additional input needed: The user did not specify their favorite city, which is necessary to generate a relevant joke.
-Please tell me your favorite city so I can share a joke about it!: boston
 
-Sure! Here's a joke about Boston:
-Why do Bostonians like to play hide and seek?
-Because good luck hiding when everyone yells, "Wicked awesome, ya gotta be here!"
-```
 
-```npcsh
-npcsh> What's the weather in Tokyo?
+```python
+import pandas as pd
+import numpy as np
+import os
+from npcsh.npc_compiler import NPC, NPCTeam, Tool
 
-handle_tool_call invoked with tool_name: generic_search_tool
 
-The weather in Tokyo, Japan, is expected to be mixed with sun and clouds. Here are some details from the recent forecasts:
+# Create test data and save to CSV
+def create_test_data(filepath="sales_data.csv"):
+    sales_data = pd.DataFrame(
+        {
+            "date": pd.date_range(start="2024-01-01", periods=90),
+            "revenue": np.random.normal(10000, 2000, 90),
+            "customer_count": np.random.poisson(100, 90),
+            "avg_ticket": np.random.normal(100, 20, 90),
+            "region": np.random.choice(["North", "South", "East", "West"], 90),
+            "channel": np.random.choice(["Online", "Store", "Mobile"], 90),
+        }
+    )
 
- • Highs: Around 53°F to 58°F with a few variations depending on the day.
+    # Add patterns to make data more realistic
+    sales_data["revenue"] *= 1 + 0.3 * np.sin(
+        np.pi * np.arange(90) / 30
+    )  # Seasonal pattern
+    sales_data.loc[sales_data["channel"] == "Mobile", "revenue"] *= 1.1  # Mobile growth
+    sales_data.loc[
+        sales_data["channel"] == "Online", "customer_count"
+    ] *= 1.2  # Online customer growth
 
- • Lows: Approximately 35°F to 40°F.
+    sales_data.to_csv(filepath, index=False)
+    return filepath, sales_data
 
- • Winds: Generally from the northwest at 5 to 10 mph.
 
- • Condition: Mainly sunny, but there may be periods of clouds and some overcast conditions throughout the week.
-For more detailed information, you can refer to sources like The Weather Channel or AccuWeather.
-/home/caug/npcww/npcsh:npcsh>
+code_execution_tool = Tool(
+    {
+        "tool_name": "execute_code",
+        "description": """Executes a Python code block with access to pandas,
+                          numpy, and matplotlib.
+                          Results should be stored in the 'results' dict to be returned.
+                          The only input should be a single code block with \n characters included.
+                          The code block must use only the  libraries or methods contained withen the
+                            pandas, numpy, and matplotlib libraries or using builtin methods.
+                          do not include any json formatting or markdown formatting.
 
-```
-In the below example, the code that was open was the screen capture analysis tool itself.
-```npcsh
-npcsh>  Can you explain what the code does in the currently open VS code window?
+                          When generating your script, the final output must be encoded in a variable
+                          named "output". e.g.
 
-handle_tool_call invoked with tool_name: screen_capture_analysis_tool
+                          output  = some_analysis_function(inputs, derived_data_from_inputs)
+                            Adapt accordingly based on the scope of the analysis
 
-Screenshot saved as screenshot_20241223_225815.png
+                          """,
+        "inputs": ["script"],
+        "steps": [
+            {
+                "engine": "python",
+                "code": """{{script}}""",
+            }
+        ],
+    }
+)
 
-The code in the visible section of your VS Code window appears to be a script for capturing and analyzing screenshots. Here's a breakdown of what the code does:
+# Analytics team definition
+analytics_team = [
+    {
+        "name": "analyst",
+        "primary_directive": "You analyze sales performance data, focusing on revenue trends, customer behavior metrics, and market indicators. Your expertise is in extracting actionable insights from complex datasets.",
+        "model": "gpt-4o-mini",
+        "provider": "openai",
+        "tools": [code_execution_tool],  # Only the code execution tool
+    },
+    {
+        "name": "researcher",
+        "primary_directive": "You specialize in causal analysis and experimental design. Given data insights, you determine what factors drive observed patterns and design tests to validate hypotheses.",
+        "model": "gpt-4o-mini",
+        "provider": "openai",
+        "tools": [code_execution_tool],  # Only the code execution tool
+    },
+    {
+        "name": "engineer",
+        "primary_directive": "You implement data pipelines and optimize data processing. When given analysis requirements, you create efficient workflows to automate insights generation.",
+        "model": "gpt-4o-mini",
+        "provider": "openai",
+        "tools": [code_execution_tool],  # Only the code execution tool
+    },
+]
 
- 1 Import Necessary Libraries: It imports required libraries like system, datetime, and pyautogui, which are essential for capturing screenshots and handling date-time operations.
 
- 2 Capture the Screen: The code captures the current screen using pyautogui.screenshot(), taking a screenshot of the entire screen.
+def create_analytics_team():
+    # Initialize NPCs with just the code execution tool
+    npcs = []
+    for npc_data in analytics_team:
+        npc = NPC(
+            name=npc_data["name"],
+            primary_directive=npc_data["primary_directive"],
+            model=npc_data["model"],
+            provider=npc_data["provider"],
+            tools=[code_execution_tool],  # Only code execution tool
+        )
+        npcs.append(npc)
 
- 3 File Management: It generates a unique filename for the screenshot using the current date and time. This ensures that each screenshot file is distinct.
+    # Create coordinator with just code execution tool
+    coordinator = NPC(
+        name="coordinator",
+        primary_directive="You coordinate the analytics team, ensuring each specialist contributes their expertise effectively. You synthesize insights and manage the workflow.",
+        model="gpt-4o-mini",
+        provider="openai",
+        tools=[code_execution_tool],  # Only code execution tool
+    )
 
- 4 Save the Screenshot: The captured screenshot is saved to a file with the generated filename.
+    # Create team
+    team = NPCTeam(npcs=npcs, foreman=coordinator)
+    return team
 
- 5 Image Analysis: It likely imports a functionality (analyze_image_base) to analyze the screenshot for specific content or information.
 
- 6 Run the Analysis: While not explicitly shown, it appears to call this analysis function to process the saved screenshot.
-In summary, this code automates the process of capturing a screenshot, saving it with a unique filename, and analyzing that image for specific content or patterns.
+def main():
+    # Create and save test data
+    data_path, sales_data = create_test_data()
 
+    # Initialize team
+    team = create_analytics_team()
 
-```
+    # Run analysis - updated prompt to reflect code execution approach
+    results = team.orchestrate(
+        f"""
+    Analyze the sales data at {data_path} to:
+    1. Identify key performance drivers
+    2. Determine if mobile channel growth is significant
+    3. Recommend tests to validate growth hypotheses
 
-```npcsh
-npcsh> What is the biggest file in my current folder?
+    Here is a header for the data file at {data_path}:
+    {sales_data.head()}
 
-LLM suggests the following bash command: ls -S | head -n 1
+    When working with dates, ensure that date columns are converted from raw strings. e.g. use the pd.to_datetime function.
 
-Running command: ls -S | head -n 1
 
-Command executed with output: image_20241111_000033.png
+    When working with potentially messy data, handle null values by using nan versions of numpy functions or
+    by filtering them with a mask .
 
-I ran the command ls -S | head -n 1 in your current folder. This command sorts all files by size in descending order and then selects the first entry, which represents the largest file. The result of this operation shows that the biggest file in your current folder is image_20241111_000033.png.
+    Use Python code execution to perform the analysis - load the data and perform statistical analysis directly.
+    """
+    )
 
-```
+    print(results)
 
-```npcsh
-npcsh>What is the best way to implement a linked list in Python?
+    # Cleanup
+    os.remove(data_path)
 
-The best way to implement a linked list in Python is to define a Node class for the individual elements and a LinkedList class to manage the nodes. Here's a basic implementation:
-class Node:
-    def __init__(self, data):
-        self.data = data  # Store the data
-        self.next = None  # Initialize the next node as None
 
-class LinkedList:
-    def __init__(self):
-        self.head = None  # Initialize the head of the list
+if __name__ == "__main__":
+    main()
 
-    def insert(self, data):
-        """Inserts a new node at the end of the linked list."""
-        new_node = Node(data)
-        if not self.head:  # If list is empty, set new node as head
-            self.head = new_node
-            return
-        last_node = self.head
-        while last_node.next:  # Traverse to the last node
-            last_node = last_node.next
-        last_node.next = new_node  # Link the new node
+```
 
-    def display(self):
-        """Prints the linked list."""
-        current = self.head
-        while current:
-            print(current.data, end=" -> ")
-            current = current.next
-        print("None")
 
-# Example usage:
-llist = LinkedList()
-llist.insert(1)
-llist.insert(2)
-llist.insert(3)
-llist.display()  # Output: 1 -> 2 -> 3 -> None
-                                                                                            Explanation:
 
- 1 Node Class: Represents each node in the linked list. It has two attributes: data (to store the value) and next (to point to the next node).
+## Star History
 
- 2 LinkedList Class: Manages the linked list. It has a head attribute pointing to the first node.
+[![Star History Chart](https://api.star-history.com/svg?repos=cagostino/npcsh&type=Date)](https://star-history.com/#cagostino/npcsh&Date)
 
- 3 Insert Method: Adds a new node to the end of the list.
+## Installation
+`npcsh` is available on PyPI and can be installed using pip. Before installing, make sure you have the necessary dependencies installed on your system. Below are the instructions for installing such dependencies on Linux, Mac, and Windows. If you find any other dependencies that are needed, please let us know so we can update the installation instructions to be more accommodating.
 
- 4 Display Method: Prints the elements of the list in order.
-This implementation is simple and can be extended with more methods (e.g., deletion, searching, etc.) as needed.
+### Linux install
+```bash
 
-```
+sudo apt-get install espeak
+sudo apt-get install portaudio19-dev python3-pyaudio
+sudo apt-get install alsa-base alsa-utils
+sudo apt-get install libcairo2-dev
+sudo apt-get install libgirepository1.0-dev
+sudo apt-get install ffmpeg
 
-```npcsh
-npcsh> In which of the files in the current directory is "Simon Bolivar" mentioned?
+#And if you don't have ollama installed, use this:
+curl -fsSL https://ollama.com/install.sh | sh
 
-The user's query was about "Simon Bolivar." Based on the relevant context from the codebase, I found specific mentions and relevant information regarding Simon Bolívar in the documentation provided
-in the README.md file.
-From the relevant context, specifically in the section of README.md, it shared a code example that demonstrates how to load an NPC (Non-Player Character) named "Simon Bolivar" using SQLite and
-answer a question about project updates. This code snippet indicates that "Simon Bolivar" is represented in the NPC system, allowing for interaction through questions to retrieve information.
-Additionally, there is another passage that directly answers the query. It reads:
+ollama pull llama3.2
+ollama pull llava:7b
+ollama pull nomic-embed-text
+pip install npcsh
+```
+If you'd like to install the abilities to use STT and TTS, additionall install the following
+```
+pip install openai-whisper pyaudio gtts playsound
+```
 
-▌ "Simón Bolívar, often referred to as 'El Libertador,' was a Venezuelan military and political leader who played a key role in the Latin American wars of independence against Spanish colonial
-▌ rule in the early 19th century."
-This information highlights Bolívar's significant historical role and achievements, answering the query regarding who Simon Bolivar was, thus making it clear that he was a prominent leader in Latin
-America's fight for independence.
-To summarize, I arrived at this answer by examining the provided context in the README.md file that includes both the coding example that initializes an NPC named "Simon Bolivar" and a historical
-overview of his contributions, which directly addresses the user's inquiry.
 
 
+### Mac install
+```bash
+brew install portaudio
+brew install ffmpeg
+brew install ollama
+brew services start ollama
+brew install pygobject3
+ollama pull llama3.2
+ollama pull llava:7b
+ollama pull nomic-embed-text
+pip install npcsh
 ```
+### Windows Install
 
+Download and install ollama exe.
 
-```npcsh
-npcsh>what process is using the most ram on my computer right now?
+Then, in a powershell. Download and install ffmpeg.
 
-LLM suggests the following bash command: ps aux --sort=-%mem | head -n 10
-Running command: ps aux --sort=-%mem | head -n 10
-Command executed with output: USER         PID %CPU %MEM    VSZ   RSS TTY      STAT START   TIME COMMAND
-caug     1040046  1.1  2.7 1226193464 1598980 ?  SNl  Dec22  23:30 /opt/vivaldi/vivaldi-bin --type=renderer --crashpad-handler-pid=4529 --enable-crash-reporter=,stable --change-stack-guard-on-fork=
-caug      683148  0.0  1.9 2047464 1137232 ?     SNl  Dec13  10:11 io.elementary.appcenter
-ollama      1884  0.0  1.8 3683920 1051020 ?     SNsl Dec02   0:30 /usr/local/bin/ollama serve
-caug     1191836  5.3  1.6 7346052 964988 pts/17 Sl+  22:57   0:22 /home/caug/.pyenv/versions/npcsh/bin/python /home/caug/.pyenv/versions/3.11.0/envs/npcsh/bin/npcsh
-caug     1145749  0.0  1.5 7068128 892500 pts/13 Sl+  Dec22   0:15 /home/caug/.pyenv/versions/3.11.0/bin/python3.11 /home/caug/.pyenv/versions/3.11.0/bin/npcsh
-caug      493912  0.0  1.5 7050968 890012 pts/11 Sl+  Dec10   0:14 /home/caug/.pyenv/versions/npcsh/bin/python /home/caug/.pyenv/versions/npcsh/bin/npcsh
-caug        4522  0.9  1.5 34391236 874756 ?     SNLl Dec02 295:06 /opt/vivaldi/vivaldi-bin
-caug        3995  0.7  1.1 6051812 683916 ?      R<sl Dec02 221:19 /usr/bin/gnome-shell
-caug      501721  0.3  1.0 1212584660 626248 ?   SNl  Dec10  60:22 /opt/vivaldi/vivaldi-bin --type=renderer --crashpad-handler-pid=4529 --enable-crash-reporter=,stable --change-stack-guard-on-fork=
-
-To determine which processes are using the most RAM on your computer, I executed the command ps aux --sort=-%mem | head -n 10.
-This command lists all running processes (ps aux), sorts them by memory usage in descending order (--sort=-%mem), and then retrieves the top 10 entries (head -n 10).
-The output shows the processes currently consuming the most memory. In the results, the process using the most RAM is Vivaldi's renderer, followed by other applications such as the Elementary App Center, Ollama server, and several instances of Python related to your NPC shell.
 ```
-
-```npcsh
-npcsh> can you generate an image of a calico cat and an orange tabby cat in the style of a japanese woodblock print where the two cats are engaged in a samurai battle but instead of samurai swords they are holding cat toys that are like wands with felt birds on the ends of them on strings
-
-handle_tool_call invoked with tool_name: image_generation_tool
+ollama pull llama3.2
+ollama pull llava:7b
+ollama pull nomic-embed-text
+pip install npcsh
 ```
-![catfight](test_data/catfight.PNG)
+As of now, npcsh appears to work well with some of the core functionalities like /ots and /whisper.
 
 
-In addition to its ability to execute one-off tasks or tool calls, npcsh also has
-the ability to generate tool call sequences when asked:
-```npcsh
+### Fedora Install (under construction)
 
-npcsh> can you use a tool sequence to find the gdp of russia in 2024 and then to use that information to generate an image?
+python3-dev (fixes hnswlib issues with chroma db)
+xhost +  (pyautogui)
+python-tkinter (pyautogui)
 
-handle_tool_call invoked with tool_name: generic_search_tool
-Tool found: generic_search_tool
-handle_tool_call invoked with tool_name: image_generation_tool
-Tool found: image_generation_tool
+## Startup Configuration and Project Structure
+After it has been pip installed, `npcsh` can be used as a command line tool. Start it by typing:
+```bash
+npcsh
+```
+When initialized, `npcsh` will generate a .npcshrc file in your home directory that stores your npcsh settings.
+Here is an example of what the .npcshrc file might look like after this has been run.
+```bash
+# NPCSH Configuration File
+export NPCSH_INITIALIZED=1
+export NPCSH_CHAT_PROVIDER='ollama'
+export NPCSH_CHAT_MODEL='llama3.2'
+export NPCSH_DB_PATH='~/npcsh_history.db'
+```
+`npcsh` also comes with a set of tools and NPCs that are used in processing. It will generate a folder at ~/.npcsh/ that contains the tools and NPCs that are used in the shell and these will be used in the absence of other project-specific ones. Additionally, `npcsh` records interactions and compiled information about npcs within a local SQLite database at the path specified in the .npcshrc file. This will default to ~/npcsh_history.db if not specified. When the data mode is used to load or analyze data in CSVs or PDFs, these data will be stored in the same database for future reference.
 
-The Gross Domestic Product (GDP) of Russia is estimated to be $8.311 trillion by the end of 2024, according to World Economics.
-This figure is significantly larger than the official estimate of $5.804 trillion published by the World Bank for the end of 2023.
+The installer will automatically add this file to your shell config, but if it does not do so successfully for whatever reason you can add the following to your .bashrc or .zshrc:
 
-It seems that you've generated an image. If you have any questions or need assistance related to this image, please let me know how I can help!
+```bash
+# Source NPCSH configuration
+if [ -f ~/.npcshrc ]; then
+    . ~/.npcshrc
+fi
 ```
-and then the associated image :
-![gdp](test_data/r8ss9a.PNG)
-
 
+We support inference via `openai`, `anthropic`, `ollama`,`gemini`, `deepseek`,  and `openai-like` APIs. The default provider must be one of `['openai','anthropic','ollama', 'gemini', 'deepseek', 'openai-like']` and the model must be one available from those providers.
 
+To use tools that require API keys, create an `.env` file up in the folder where you are working or place relevant API keys as env variables in your ~/.npcshrc. If you already have these API keys set in a ~/.bashrc or a ~/.zshrc or similar files, you need not additionally add them to ~/.npcshrc or to an `.env` file. Here is an example of what an `.env` file might look like:
 
+```bash
+export OPENAI_API_KEY="your_openai_key"
+export ANTHROPIC_API_KEY="your_anthropic_key"
+export DEEPSEEK_API_KEY='your_deepseek_key'
+export GEMINI_API_KEY='your_gemini_key'
+export PERPLEXITY_API_KEY='your_perplexity_key'
+```
 
 
+ Individual npcs can also be set to use different models and providers by setting the `model` and `provider` keys in the npc files.
+ Once initialized and set up, you will find the following in your ~/.npcsh directory:
+```bash
+~/.npcsh/
+├── npc_team/           # Global NPCs
+│   ├── tools/          # Global tools
+│   └── assembly_lines/ # Workflow pipelines
 
-### Piping outputs
-An important facet that makes `npcsh` so powerful is the ability to pipe outputs from one tool call to another. This allows for the chaining of commands and the creation of complex workflows. For example, you can use the output of a search to generate an image, or you can use the output of an image analysis to generate a report. Here is an example of how this might look in practice:
-```npcsh
-npcsh> what is the gdp of russia in 2024? | /vixynt 'generate an image that contains {0}'
+```
+For cases where you wish to set up a project specific set of NPCs, tools, and assembly lines, add a `npc_team` directory to your project and `npcsh` should be able to pick up on its presence, like so:
+```bash
+./npc_team/            # Project-specific NPCs
+├── tools/             # Project tools #example tool next
+│   └── example.tool
+└── assembly_lines/    # Project workflows
+    └── example.pipe
+└── models/    # Project workflows
+    └── example.model
+└── example1.npc        # Example NPC
+└── example2.npc        # Example NPC
+└── example1.ctx        # Example NPC
+└── example2.ctx        # Example NPC
 
-### Executing Bash Commands
-You can execute bash commands directly within npcsh. The LLM can also generate and execute bash commands based on your natural language requests.
-For example:
-```npcsh
-npcsh> ls -l
+```
 
-npcsh> cp file1.txt file2.txt
-npcsh> mv file1.txt file2.txt
-npcsh> mkdir new_directory
-npcsh> git status
-npcsh> vim file.txt
+## IMPORTANT: migrations and deprecations
 
+### v0.3.4
+-In v0.3.4, the structure for tools was adjusted. If you have made custom tools please refer to the structure within npc_compiler to ensure that they are in the correct format. Otherwise, do the following
+```bash
+rm ~/.npcsh/npc_team/tools/*.tool
+```
+and then
+```bash
+npcsh
 ```
+and the updated tools will be copied over into the correct location.
 
-### NPC CLI
-When npcsh is installed, it comes with the `npc` cli as well. The `npc` cli has various command to make initializing and serving NPC projects easier.
+### v0.3.5
+-Version 0.3.5 included a complete overhaul and refactoring of the llm_funcs module. This was done to make it not as horribly long and to make it easier to add new models and providers
 
-Users can make queries like so:
-```bash
-$ npc 'whats the biggest filei  n my computer'
-Loaded .env file from /home/caug/npcww/npcsh
-action chosen: request_input
-explanation given: The user needs to provide more context about their operating system or specify which directory to search for the biggest file.
 
-Additional input needed: The user did not specify their operating system or the directory to search for the biggest file, making it unclear how to execute the command.
-Please specify your operating system (e.g., Windows, macOS, Linux) and the directory you want to search in.: linux and root
-action chosen: execute_command
-explanation given: The user is asking for the biggest file on their computer, which can be accomplished with a simple bash command that searches for the largest files.
-sibiji generating command
-LLM suggests the following bash command: sudo find / -type f -exec du -h {} + | sort -rh | head -n 1
-Running command: sudo find / -type f -exec du -h {} + | sort -rh | head -n 1
-Command executed with output: 11G       /home/caug/.cache/huggingface/hub/models--state-spaces--mamba-2.8b/blobs/39911a8470a2b256016b57cc71c68e0f96751cba5b229216ab1f4f9d82096a46
+-in version 0.3.5, a change was introduced to the database schema for messages to add npcs, models, providers, and associated attachments to data. If you have used `npcsh` before this version, you will need to run this migration script to update your database schema:   [migrate_conversation_history_v0.3.5.py](https://github.com/cagostino/npcsh/blob/cfb9dc226e227b3e888f3abab53585693e77f43d/npcsh/migrations/migrate_conversation_history_%3Cv0.3.4-%3Ev0.3.5.py)
 
-I ran a command on your Linux system that searches for the largest files on your computer. The command `sudo find / -type f -exec du -h {} + | sort -rh | head -n 1` performs the following steps:
+-additionally, NPCSH_MODEL and NPCSH_PROVIDER have been renamed to NPCSH_CHAT_MODEL and NPCSH_CHAT_PROVIDER
+to provide a more consistent naming scheme now that we have additionally introduced `NPCSH_VISION_MODEL` and `NPCSH_VISION_PROVIDER`, `NPCSH_EMBEDDING_MODEL`, `NPCSH_EMBEDDING_PROVIDER`, `NPCSH_REASONING_MODEL`, `NPCSH_REASONING_PROVIDER`, `NPCSH_IMAGE_GEN_MODEL`, and `NPCSH_IMAGE_GEN_PROVIDER`.
+- In addition, we have added NPCSH_API_URL to better accommodate openai-like apis that require a specific url to be set as well as `NPCSH_STREAM_OUTPUT` to indicate whether or not to use streaming in one's responses. It will be set to 0 (false) by default as it has only been tested  and verified for a small subset of the models and providers we have available (openai, anthropic, and ollama). If you try it and run into issues, please post them here so we can correct them as soon as possible !
 
-1. **Find Command**: It searches for all files (`-type f`) starting from the root directory (`/`).
-2. **Disk Usage**: For each file found, it calculates its disk usage in a human-readable format (`du -h`).
-3. **Sort**: It sorts the results in reverse order based on size (`sort -rh`), so the largest files appear first.
-4. **Head**: Finally, it retrieves just the largest file using `head -n 1`.
 
-The output indicates that the biggest file on your system is located at `/home/caug/.cache/huggingface/hub/models--state-spaces--mamba-2.8b/blobs/39911a8470a2b256016b57cc71c68e0f96751cba5b229216ab1f4f9d82096a46` and is 11GB in size.
+## npcsh usage
+In the `npcsh` shell, users can ask LLMs questions, have LLMLs execute commands or use tools, or utilize macros that provide additional functionality. When a user does not invoke a specific macro, the shell will automatically decide which tool to use based on the user's input. Here are some examples of things one might ask the npcsh shell.
 
+Here are some examples of how you can use npcsh
+```npcsh
+npcsh>Who was Simon Bolivar?
+
+Simón Bolívar, often referred to as "El Libertador," was a Venezuelan military and political leader who played a key role in the Latin American wars of independence against Spanish
+colonial rule in the early 19th century. He was born on July 24, 1783, in Caracas, Venezuela, into a wealthy Creole family.
+Bolívar's vision extended beyond merely liberating territories; he aspired to unify the newly independent nations of South America into a single federation, which he called "Gran
+Colombia," consisting of present-day Colombia, Venezuela, Ecuador, and Panama. He was known for his exceptional military strategies and leadership, which led to successful campaigns in
+various regions, including the battles of Boyacá, Carabobo, and Ayacucho.
+He faced numerous challenges, including political fragmentation, regional rivalries, and personal betrayals. Despite his initial successes, the unity he sought for Latin America proved
+difficult to achieve, and Gran Colombia eventually disintegrated in the early 1830s.
+Bolívar's influence and legacy extend far beyond his lifetime. He is celebrated in various countries across Latin America as a national hero and symbol of independence. His thoughts on
+liberty, governance, and social issues continue to inspire movements for democracy and social justice in the region. Simón Bolívar died on December 17, 1830, but remains a pivotal figure
+in the history of Latin America.
 ```
 
-```bash
-$ npc 'whats the weather in tokyo'
-Loaded .env file from /home/caug/npcww/npcsh
-action chosen: invoke_tool
-explanation given: The user's request for the current weather in Tokyo requires up-to-date information, which can be best obtained through an internet search.
-Tool found: internet_search
-Executing tool with input values: {'query': 'whats the weather in tokyo'}
-QUERY in tool whats the weather in tokyo
-[{'title': 'Tokyo, Tokyo, Japan Weather Forecast | AccuWeather', 'href': 'https://www.accuweather.com/en/jp/tokyo/226396/weather-forecast/226396', 'body': 'Tokyo, Tokyo, Japan Weather Forecast, with current conditions, wind, air quality, and what to expect for the next 3 days.'}, {'title': 'Tokyo, Japan 14 day weather forecast - timeanddate.com', 'href': 'https://www.timeanddate.com/weather/japan/tokyo/ext', 'body': 'Tokyo Extended Forecast with high and low temperatures. °F. Last 2 weeks of weather'}, {'title': 'Tokyo, Tokyo, Japan Current Weather | AccuWeather', 'href': 'https://www.accuweather.com/en/jp/tokyo/226396/current-weather/226396', 'body': 'Current weather in Tokyo, Tokyo, Japan. Check current conditions in Tokyo, Tokyo, Japan with radar, hourly, and more.'}, {'title': 'Weather in Tokyo, Japan - timeanddate.com', 'href': 'https://www.timeanddate.com/weather/japan/tokyo', 'body': 'Current weather in Tokyo and forecast for today, tomorrow, and next 14 days'}, {'title': 'Tokyo Weather Forecast Today', 'href': 'https://japanweather.org/tokyo', 'body': "For today's mild weather in Tokyo, with temperatures between 13ºC to 16ºC (55.4ºF to 60.8ºF), consider wearing: - Comfortable jeans or slacks - Sun hat (if spending time outdoors) - Lightweight sweater or cardigan - Long-sleeve shirt or blouse. Temperature. Day. 14°C. Night. 10°C. Morning. 10°C. Afternoon."}] <class 'list'>
-RESULTS in tool ["Tokyo, Tokyo, Japan Weather Forecast, with current conditions, wind, air quality, and what to expect for the next 3 days.\n Citation: https://www.accuweather.com/en/jp/tokyo/226396/weather-forecast/226396\n\n\n\nTokyo Extended Forecast with high and low temperatures. °F. Last 2 weeks of weather\n Citation: https://www.timeanddate.com/weather/japan/tokyo/ext\n\n\n\nCurrent weather in Tokyo, Tokyo, Japan. Check current conditions in Tokyo, Tokyo, Japan with radar, hourly, and more.\n Citation: https://www.accuweather.com/en/jp/tokyo/226396/current-weather/226396\n\n\n\nCurrent weather in Tokyo and forecast for today, tomorrow, and next 14 days\n Citation: https://www.timeanddate.com/weather/japan/tokyo\n\n\n\nFor today's mild weather in Tokyo, with temperatures between 13ºC to 16ºC (55.4ºF to 60.8ºF), consider wearing: - Comfortable jeans or slacks - Sun hat (if spending time outdoors) - Lightweight sweater or cardigan - Long-sleeve shirt or blouse. Temperature. Day. 14°C. Night. 10°C. Morning. 10°C. Afternoon.\n Citation: https://japanweather.org/tokyo\n\n\n", 'https://www.accuweather.com/en/jp/tokyo/226396/weather-forecast/226396\n\nhttps://www.timeanddate.com/weather/japan/tokyo/ext\n\nhttps://www.accuweather.com/en/jp/tokyo/226396/current-weather/226396\n\nhttps://www.timeanddate.com/weather/japan/tokyo\n\nhttps://japanweather.org/tokyo\n']
-The current weather in Tokyo, Japan is mild, with temperatures ranging from 13°C to 16°C (approximately 55.4°F to 60.8°F). For today's conditions, it is suggested to wear comfortable jeans or slacks, a lightweight sweater or cardigan, and a long-sleeve shirt or blouse, especially if spending time outdoors. The temperature today is expected to reach a high of 14°C (57.2°F) during the day and a low of 10°C (50°F) at night.
 
-For more detailed weather information, you can check out the following sources:
-- [AccuWeather Forecast](https://www.accuweather.com/en/jp/tokyo/226396/weather-forecast/226396)
-- [Time and Date Extended Forecast](https://www.timeanddate.com/weather/japan/tokyo/ext)
-- [Current Weather on AccuWeather](https://www.accuweather.com/en/jp/tokyo/226396/current-weather/226396)
-- [More on Time and Date](https://www.timeanddate.com/weather/japan/tokyo)
-- [Japan Weather](https://japanweather.org/tokyo)
+```npcsh
+npcsh> What is the capital of France?
+The capital of France is Paris. It is the largest city in the country and is known for its rich history, art, culture, and architecture, including famous landmarks such as the Eiffel Tower, Notre-Dame Cathedral, and the Louvre Museum.
 ```
 
+```npcsh
+npcsh> can you tell me a joke about my favorite city?
 
-### Serving
-To serve an NPC project, first install redis-server and start it
-
-on Ubuntu:
-```bash
-sudo apt update && sudo apt install redis-server
-redis-server
-```
+Additional input needed: The user did not specify their favorite city, which is necessary to generate a relevant joke.
+Please tell me your favorite city so I can share a joke about it!: boston
 
-on macOS:
-```bash
-brew install redis
-redis-server
+Sure! Here's a joke about Boston:
+Why do Bostonians like to play hide and seek?
+Because good luck hiding when everyone yells, "Wicked awesome, ya gotta be here!"
 ```
-Then navigate to the project directory and run:
 
-```bash
-npc serve
-```
-If you want to specify a certain port, you can do so with the `-p` flag:
-```bash
-npc serve -p 5337
-```
-or with the `--port` flag:
-```bash
-npc serve --port 5337
+```npcsh
+npcsh> What's the weather in Tokyo?
 
-```
-If you want to initialize a project based on templates and then make it available for serving, you can do so like this
-```bash
-npc serve -t 'sales, marketing' -ctx 'im developing a team that will focus on sales and marketing within the logging industry. I need a team that can help me with the following: - generate leads - create marketing campaigns - build a sales funnel - close deals - manage customer relationships - manage sales pipeline - manage marketing campaigns - manage marketing budget' -m llama3.2 -pr ollama
-```
-This will use the specified model and provider to generate a team of npcs to fit the templates and context provided.
+handle_tool_call invoked with tool_name: generic_search_tool
 
+The weather in Tokyo, Japan, is expected to be mixed with sun and clouds. Here are some details from the recent forecasts:
 
-Once the server is up and running, you can access the API endpoints at `http://localhost:5337/api/`. Here are some example curl commands to test the endpoints:
+ • Highs: Around 53°F to 58°F with a few variations depending on the day.
 
-```bash
-echo "Testing health endpoint..."
-curl -s http://localhost:5337/api/health | jq '.'
+ • Lows: Approximately 35°F to 40°F.
 
-echo -e "\nTesting execute endpoint..."
-curl -s -X POST http://localhost:5337/api/execute \
-  -H "Content-Type: application/json" \
-  -d '{"commandstr": "hello world", "currentPath": "~/", "conversationId": "test124"}' | jq '.'
+ • Winds: Generally from the northwest at 5 to 10 mph.
 
-echo -e "\nTesting conversations endpoint..."
-curl -s "http://localhost:5337/api/conversations?path=/tmp" | jq '.'
+ • Condition: Mainly sunny, but there may be periods of clouds and some overcast conditions throughout the week.
+For more detailed information, you can refer to sources like The Weather Channel or AccuWeather.
+/home/caug/npcww/npcsh:npcsh>
 
-echo -e "\nTesting conversation messages endpoint..."
-curl -s http://localhost:5337/api/conversation/test123/messages | jq '.'
 ```
+In the below example, the code that was open was the screen capture analysis tool itself.
+```npcsh
+npcsh>  Can you explain what the code does in the currently open VS code window?
 
-###
+handle_tool_call invoked with tool_name: screen_capture_analysis_tool
 
+Screenshot saved as screenshot_20241223_225815.png
 
-* **Planned:** -npc scripts
--npc run select +sql_model   <run up>
--npc run select +sql_model+  <run up and down>
--npc run select sql_model+  <run down>
--npc run line <assembly_line>
--npc conjure fabrication_plan.fab
+The code in the visible section of your VS Code window appears to be a script for capturing and analyzing screenshots. Here's a breakdown of what the code does:
 
+ 1 Import Necessary Libraries: It imports required libraries like system, datetime, and pyautogui, which are essential for capturing screenshots and handling date-time operations.
 
+ 2 Capture the Screen: The code captures the current screen using pyautogui.screenshot(), taking a screenshot of the entire screen.
 
-## Macros
+ 3 File Management: It generates a unique filename for the screenshot using the current date and time. This ensures that each screenshot file is distinct.
 
-While npcsh can decide the best option to use based on the user's input, the user can also execute certain actions with a macro. Macros are commands within the NPC shell that start with a forward slash (/) and are followed (in some cases) by the relevant arguments for those macros. Each macro is also available as a sub-program within the NPC CLI. In the following examples we demonstrate how to carry out the same operations from within npcsh and from a regular shell.
+ 4 Save the Screenshot: The captured screenshot is saved to a file with the generated filename.
 
+ 5 Image Analysis: It likely imports a functionality (analyze_image_base) to analyze the screenshot for specific content or information.
 
-To learn about the available macros from within the shell, type:
-```npcsh
-npcsh> /help
-```
+ 6 Run the Analysis: While not explicitly shown, it appears to call this analysis function to process the saved screenshot.
+In summary, this code automates the process of capturing a screenshot, saving it with a unique filename, and analyzing that image for specific content or patterns.
 
-or from bash
-```bash
-npc --help
-#alternatively
-npc -h
-```
 
-To exit the shell:
-```npcsh
-npcsh> /exit
 ```
 
-Otherwise, here are some more detailed examples of macros that can be used in npcsh:
-### Conjure (under construction)
-Use the `/conjure` macro to generate an NPC, a NPC tool, an assembly line, a job, or an SQL model
+```npcsh
+npcsh> What is the biggest file in my current folder?
 
-```bash
-npc conjure -n name -t 'templates'
-```
+LLM suggests the following bash command: ls -S | head -n 1
 
+Running command: ls -S | head -n 1
 
-### Data Interaction and analysis (under construction)
+Command executed with output: image_20241111_000033.png
 
+I ran the command ls -S | head -n 1 in your current folder. This command sorts all files by size in descending order and then selects the first entry, which represents the largest file. The result of this operation shows that the biggest file in your current folder is image_20241111_000033.png.
 
-### Debate (under construction)
-Use the `/debate` macro to have two or more NPCs debate a topic, problem, or question.
+```
 
-For example:
 ```npcsh
-npcsh> /debate Should humans colonize Mars? npcs = ['sibiji', 'mark', 'ted']
-```
+npcsh>What is the best way to implement a linked list in Python?
 
+The best way to implement a linked list in Python is to define a Node class for the individual elements and a LinkedList class to manage the nodes. Here's a basic implementation:
+class Node:
+    def __init__(self, data):
+        self.data = data  # Store the data
+        self.next = None  # Initialize the next node as None
 
+class LinkedList:
+    def __init__(self):
+        self.head = None  # Initialize the head of the list
 
-### Notes
-Jot down notes and store them within the npcsh database and in the current directory as a text file.
-```npcsh
-npcsh> /notes
-```
+    def insert(self, data):
+        """Inserts a new node at the end of the linked list."""
+        new_node = Node(data)
+        if not self.head:  # If list is empty, set new node as head
+            self.head = new_node
+            return
+        last_node = self.head
+        while last_node.next:  # Traverse to the last node
+            last_node = last_node.next
+        last_node.next = new_node  # Link the new node
 
+    def display(self):
+        """Prints the linked list."""
+        current = self.head
+        while current:
+            print(current.data, end=" -> ")
+            current = current.next
+        print("None")
 
-### Over-the-shoulder: Screenshots and image analysis
+# Example usage:
+llist = LinkedList()
+llist.insert(1)
+llist.insert(2)
+llist.insert(3)
+llist.display()  # Output: 1 -> 2 -> 3 -> None
+                                                                                            Explanation:
 
-Use the /ots macro to take a screenshot and write a prompt for an LLM to answer about the screenshot.
-```npcsh
-npcsh> /ots
+ 1 Node Class: Represents each node in the linked list. It has two attributes: data (to store the value) and next (to point to the next node).
 
-Screenshot saved to: /home/caug/.npcsh/screenshots/screenshot_1735015011.png
+ 2 LinkedList Class: Manages the linked list. It has a head attribute pointing to the first node.
 
-Enter a prompt for the LLM about this image (or press Enter to skip): describe whats in this image
+ 3 Insert Method: Adds a new node to the end of the list.
 
-The image displays a source control graph, likely from a version control system like Git. It features a series of commits represented by colored dots connected by lines, illustrating the project's development history. Each commit message provides a brief description of the changes made, including tasks like fixing issues, merging pull requests, updating README files, and adjusting code or documentation. Notably, several commits mention specific users, particularly "Chris Agostino," indicating collaboration and contributions to the project. The graph visually represents the branching and merging of code changes.
-```
+ 4 Display Method: Prints the elements of the list in order.
+This implementation is simple and can be extended with more methods (e.g., deletion, searching, etc.) as needed.
 
-In bash:
-```bash
-npc ots
 ```
 
-
-
-Alternatively, pass an existing image in like :
 ```npcsh
-npcsh> /ots test_data/catfight.PNG
-Enter a prompt for the LLM about this image (or press Enter to skip): whats in this ?
+npcsh> In which of the files in the current directory is "Simon Bolivar" mentioned?
 
-The image features two cats, one calico and one orange tabby, playing with traditional Japanese-style toys. They are each holding sticks attached to colorful pom-pom balls, which resemble birds. The background includes stylized waves and a red sun, accentuating a vibrant, artistic style reminiscent of classic Japanese art. The playful interaction between the cats evokes a lively, whimsical scene.
-```
+The user's query was about "Simon Bolivar." Based on the relevant context from the codebase, I found specific mentions and relevant information regarding Simon Bolívar in the documentation provided
+in the README.md file.
+From the relevant context, specifically in the section of README.md, it shared a code example that demonstrates how to load an NPC (Non-Player Character) named "Simon Bolivar" using SQLite and
+answer a question about project updates. This code snippet indicates that "Simon Bolivar" is represented in the NPC system, allowing for interaction through questions to retrieve information.
+Additionally, there is another passage that directly answers the query. It reads:
 
-```bash
-npc ots -f test_data/catfight.PNG
-```
+▌ "Simón Bolívar, often referred to as 'El Libertador,' was a Venezuelan military and political leader who played a key role in the Latin American wars of independence against Spanish colonial
+▌ rule in the early 19th century."
+This information highlights Bolívar's significant historical role and achievements, answering the query regarding who Simon Bolivar was, thus making it clear that he was a prominent leader in Latin
+America's fight for independence.
+To summarize, I arrived at this answer by examining the provided context in the README.md file that includes both the coding example that initializes an NPC named "Simon Bolivar" and a historical
+overview of his contributions, which directly addresses the user's inquiry.
 
 
-### Plan : Schedule tasks to be run at regular intervals (under construction)
-Use the /plan macro to schedule tasks to be run at regular intervals.
-```npcsh
-npcsh> /plan run a rag search on the files in the current directory every 5 minutes
 ```
 
-```bash
-npc plan -f 30m -t 'task'
-```
 
-### Plonk : Computer Control
-Use the /plonk macro to allow the LLM to control your computer.
 ```npcsh
-npcsh> /plonk go to a web browser and  go to wikipedia and find out information about simon bolivar
-```
-
-```bash
-npc plonk 'use a web browser to find out information about simon boliver'
-```
-
-### RAG
+npcsh>what process is using the most ram on my computer right now?
 
-Use the /rag macro to perform a local rag search.
-If you pass a `-f` flag with a filename or list of filenames (e.g. *.py) then it will embed the documents and perform the cosine similarity scoring.
+LLM suggests the following bash command: ps aux --sort=-%mem | head -n 10
+Running command: ps aux --sort=-%mem | head -n 10
+Command executed with output: USER         PID %CPU %MEM    VSZ   RSS TTY      STAT START   TIME COMMAND
+caug     1040046  1.1  2.7 1226193464 1598980 ?  SNl  Dec22  23:30 /opt/vivaldi/vivaldi-bin --type=renderer --crashpad-handler-pid=4529 --enable-crash-reporter=,stable --change-stack-guard-on-fork=
+caug      683148  0.0  1.9 2047464 1137232 ?     SNl  Dec13  10:11 io.elementary.appcenter
+ollama      1884  0.0  1.8 3683920 1051020 ?     SNsl Dec02   0:30 /usr/local/bin/ollama serve
+caug     1191836  5.3  1.6 7346052 964988 pts/17 Sl+  22:57   0:22 /home/caug/.pyenv/versions/npcsh/bin/python /home/caug/.pyenv/versions/3.11.0/envs/npcsh/bin/npcsh
+caug     1145749  0.0  1.5 7068128 892500 pts/13 Sl+  Dec22   0:15 /home/caug/.pyenv/versions/3.11.0/bin/python3.11 /home/caug/.pyenv/versions/3.11.0/bin/npcsh
+caug      493912  0.0  1.5 7050968 890012 pts/11 Sl+  Dec10   0:14 /home/caug/.pyenv/versions/npcsh/bin/python /home/caug/.pyenv/versions/npcsh/bin/npcsh
+caug        4522  0.9  1.5 34391236 874756 ?     SNLl Dec02 295:06 /opt/vivaldi/vivaldi-bin
+caug        3995  0.7  1.1 6051812 683916 ?      R<sl Dec02 221:19 /usr/bin/gnome-shell
+caug      501721  0.3  1.0 1212584660 626248 ?   SNl  Dec10  60:22 /opt/vivaldi/vivaldi-bin --type=renderer --crashpad-handler-pid=4529 --enable-crash-reporter=,stable --change-stack-guard-on-fork=
 
-```npcsh
-npcsh> /rag -f *.py  what is the best way to implement a linked list in Python?
+To determine which processes are using the most RAM on your computer, I executed the command ps aux --sort=-%mem | head -n 10.
+This command lists all running processes (ps aux), sorts them by memory usage in descending order (--sort=-%mem), and then retrieves the top 10 entries (head -n 10).
+The output shows the processes currently consuming the most memory. In the results, the process using the most RAM is Vivaldi's renderer, followed by other applications such as the Elementary App Center, Ollama server, and several instances of Python related to your NPC shell.
 ```
 
-Alternatively , if you want to perform rag on your past conversations, you can do so like this:
 ```npcsh
-npcsh> /rag  what is the best way to implement a linked list in Python?
-```
-and it will automatically look through the recorded conversations in the ~/npcsh_history.db
-
+npcsh> can you generate an image of a calico cat and an orange tabby cat in the style of a japanese woodblock print where the two cats are engaged in a samurai battle but instead of samurai swords they are holding cat toys that are like wands with felt birds on the ends of them on strings
 
-In bash:
-```bash
-npc rag -f *.py
+handle_tool_call invoked with tool_name: image_generation_tool
 ```
+![catfight](test_data/catfight.PNG)
 
-### Rehash
-
-Use the /rehash macro to re-send the last message to the LLM.
-```npcsh
-npcsh> /rehash
-```
 
-### Sample
-Send a one-shot question to the LLM.
+In addition to its ability to execute one-off tasks or tool calls, npcsh also has
+the ability to generate tool call sequences when asked:
 ```npcsh
-npcsh> /sample What is the capital of France?
-```
 
-Bash:
-```bash
-npc sample 'thing' -m model -p provider
+npcsh> can you use a tool sequence to find the gdp of russia in 2024 and then to use that information to generate an image?
 
-```
+handle_tool_call invoked with tool_name: generic_search_tool
+Tool found: generic_search_tool
+handle_tool_call invoked with tool_name: image_generation_tool
+Tool found: image_generation_tool
 
+The Gross Domestic Product (GDP) of Russia is estimated to be $8.311 trillion by the end of 2024, according to World Economics.
+This figure is significantly larger than the official estimate of $5.804 trillion published by the World Bank for the end of 2023.
 
-### Search
-Search can be accomplished through the `/search` macro. You can specify the provider as being "perplexity" or "duckduckgo". For the former,
-you must set a perplexity api key as an environment variable as described above. The default provider is duckduckgo.
+It seems that you've generated an image. If you have any questions or need assistance related to this image, please let me know how I can help!
+```
+and then the associated image :
+![gdp](test_data/r8ss9a.PNG)
 
-NOTE: while google is an available search engine, they recently implemented changes (early 2025) that make the python google search package no longer as reliable.
-For now, we will use duckduckgo and revisit this issue when other more critical aspects are handled.
 
 
-```npcsh
-npcsh!> /search -p duckduckgo  who is the current us president
 
 
-President Donald J. Trump entered office on January 20, 2025. News, issues, and photos of the President Footer Disclaimer This is the official website of the U.S. Mission to the United Nations. External links to other Internet sites should not be construed as an endorsement of the views or privacy policies contained therein.
 
-Citation: https://usun.usmission.gov/our-leaders/the-president-of-the-united-states/
-45th & 47th President of the United States After a landslide election victory in 2024, President Donald J. Trump is returning to the White House to build upon his previous successes and use his mandate to reject the extremist policies of the radical left while providing tangible quality of life improvements for the American people. Vice President of the United States In 2024, President Donald J. Trump extended JD the incredible honor of asking him to serve as the Vice-Presidential Nominee for th...
-Citation: https://www.whitehouse.gov/administration/
-Citation: https://www.instagram.com/potus/?hl=en
-The president of the United States (POTUS)[B] is the head of state and head of government of the United States. The president directs the executive branch of the federal government and is the commander-in-chief of the United States Armed Forces. The power of the presidency has grown substantially[12] since the first president, George Washington, took office in 1789.[6] While presidential power has ebbed and flowed over time, the presidency has played an increasingly significant role in American ...
-Citation: https://en.wikipedia.org/wiki/President_of_the_United_States
-Citation Links: https://usun.usmission.gov/our-leaders/the-president-of-the-united-states/
-https://www.whitehouse.gov/administration/
-https://www.instagram.com/potus/?hl=en
-https://en.wikipedia.org/wiki/President_of_the_United_States
-```
 
+### Piping outputs
+An important facet that makes `npcsh` so powerful is the ability to pipe outputs from one tool call to another. This allows for the chaining of commands and the creation of complex workflows. For example, you can use the output of a search to generate an image, or you can use the output of an image analysis to generate a report. Here is an example of how this might look in practice:
+```npcsh
+npcsh> what is the gdp of russia in 2024? | /vixynt 'generate an image that contains {0}'
 
+### Executing Bash Commands
+You can execute bash commands directly within npcsh. The LLM can also generate and execute bash commands based on your natural language requests.
+For example:
 ```npcsh
-npcsh> /search -p perplexity who is the current us president
-The current President of the United States is Donald Trump, who assumed office on January 20, 2025, for his second non-consecutive term as the 47th president[1].
+npcsh> ls -l
+
+npcsh> cp file1.txt file2.txt
+npcsh> mv file1.txt file2.txt
+npcsh> mkdir new_directory
+npcsh> git status
+npcsh> vim file.txt
 
-Citation Links: ['https://en.wikipedia.org/wiki/List_of_presidents_of_the_United_States',
-'https://en.wikipedia.org/wiki/Joe_Biden',
-'https://www.britannica.com/topic/Presidents-of-the-United-States-1846696',
-'https://news.gallup.com/poll/329384/presidential-approval-ratings-joe-biden.aspx',
-'https://www.usa.gov/presidents']
 ```
 
-Bash:
+### NPC CLI
+When npcsh is installed, it comes with the `npc` cli as well. The `npc` cli has various command to make initializing and serving NPC projects easier.
 
+Users can make queries like so:
 ```bash
-(npcsh) caug@pop-os:~/npcww/npcsh$ npc search 'simon bolivar' -sp perplexity
+$ npc 'whats the biggest filei  n my computer'
 Loaded .env file from /home/caug/npcww/npcsh
-urls ['https://en.wikipedia.org/wiki/Sim%C3%B3n_Bol%C3%ADvar', 'https://www.britannica.com/biography/Simon-Bolivar', 'https://en.wikipedia.org/wiki/File:Sim%C3%B3n_Bol%C3%ADvar_2.jpg', 'https://www.historytoday.com/archive/simon-bolivar-and-spanish-revolutions', 'https://kids.britannica.com/kids/article/Sim%C3%B3n-Bol%C3%ADvar/352872']
-openai
-- Simón José Antonio de la Santísima Trinidad Bolívar Palacios Ponte y Blanco[c] (24 July 1783 – 17 December 1830) was a Venezuelan statesman and military officer who led what are currently the countries of Colombia, Venezuela, Ecuador, Peru, Panama, and Bolivia to independence from the Spanish Empire. He is known colloquially as El Libertador, or the Liberator of America. Simón Bolívar was born in Caracas in the Captaincy General of Venezuela into a wealthy family of American-born Spaniards (crio...
- Citation: https://en.wikipedia.org/wiki/Sim%C3%B3n_Bol%C3%ADvar
+action chosen: request_input
+explanation given: The user needs to provide more context about their operating system or specify which directory to search for the biggest file.
 
+Additional input needed: The user did not specify their operating system or the directory to search for the biggest file, making it unclear how to execute the command.
+Please specify your operating system (e.g., Windows, macOS, Linux) and the directory you want to search in.: linux and root
+action chosen: execute_command
+explanation given: The user is asking for the biggest file on their computer, which can be accomplished with a simple bash command that searches for the largest files.
+sibiji generating command
+LLM suggests the following bash command: sudo find / -type f -exec du -h {} + | sort -rh | head -n 1
+Running command: sudo find / -type f -exec du -h {} + | sort -rh | head -n 1
+Command executed with output: 11G       /home/caug/.cache/huggingface/hub/models--state-spaces--mamba-2.8b/blobs/39911a8470a2b256016b57cc71c68e0f96751cba5b229216ab1f4f9d82096a46
 
+I ran a command on your Linux system that searches for the largest files on your computer. The command `sudo find / -type f -exec du -h {} + | sort -rh | head -n 1` performs the following steps:
 
-Our editors will review what you’ve submitted and determine whether to revise the article. Simón Bolívar was a Venezuelan soldier and statesman who played a central role in the South American independence movement. Bolívar served as president of Gran Colombia (1819–30) and as dictator of Peru (1823–26). The country of Bolivia is named for him. Simón Bolívar was born on July 24, 1783, in Caracas, Venezuela. Neither Bolívar’s aristocrat father nor his mother lived to see his 10th birthday. Bolívar...
- Citation: https://www.britannica.com/biography/Simon-Bolivar
+1. **Find Command**: It searches for all files (`-type f`) starting from the root directory (`/`).
+2. **Disk Usage**: For each file found, it calculates its disk usage in a human-readable format (`du -h`).
+3. **Sort**: It sorts the results in reverse order based on size (`sort -rh`), so the largest files appear first.
+4. **Head**: Finally, it retrieves just the largest file using `head -n 1`.
 
+The output indicates that the biggest file on your system is located at `/home/caug/.cache/huggingface/hub/models--state-spaces--mamba-2.8b/blobs/39911a8470a2b256016b57cc71c68e0f96751cba5b229216ab1f4f9d82096a46` and is 11GB in size.
 
+```
 
-Original file (1,525 × 1,990 pixels, file size: 3.02 MB, MIME type: image/jpeg) Derivative works of this file: Simón Bolívar 5.jpg This work is in the public domain in its country of origin and other countries and areas where the copyright term is the author's life plus 100 years or fewer. This work is in the public domain in the United States because it was published (or registered with the U.S. Copyright Office) before January 1, 1930. https://creativecommons.org/publicdomain/mark/1.0/PDMCreat...
- Citation: https://en.wikipedia.org/wiki/File:Sim%C3%B3n_Bol%C3%ADvar_2.jpg
-
-
-
-SubscriptionOffers Give a Gift Subscribe A map of Gran Colombia showing the 12 departments created in 1824 and territories disputed with neighboring countries. What role did Simon Bolivar play in the history of Latin America's independence from Spain? Simon Bolivar lived a short but comprehensive life. History records his extraordinary versatility. He was a revolutionary who freed six countries, an intellectual who argued the problems of national liberation, a general who fought a war of unremit...
- Citation: https://www.historytoday.com/archive/simon-bolivar-and-spanish-revolutions
-
+```bash
+$ npc 'whats the weather in tokyo'
+Loaded .env file from /home/caug/npcww/npcsh
+action chosen: invoke_tool
+explanation given: The user's request for the current weather in Tokyo requires up-to-date information, which can be best obtained through an internet search.
+Tool found: internet_search
+Executing tool with input values: {'query': 'whats the weather in tokyo'}
+QUERY in tool whats the weather in tokyo
+[{'title': 'Tokyo, Tokyo, Japan Weather Forecast | AccuWeather', 'href': 'https://www.accuweather.com/en/jp/tokyo/226396/weather-forecast/226396', 'body': 'Tokyo, Tokyo, Japan Weather Forecast, with current conditions, wind, air quality, and what to expect for the next 3 days.'}, {'title': 'Tokyo, Japan 14 day weather forecast - timeanddate.com', 'href': 'https://www.timeanddate.com/weather/japan/tokyo/ext', 'body': 'Tokyo Extended Forecast with high and low temperatures. °F. Last 2 weeks of weather'}, {'title': 'Tokyo, Tokyo, Japan Current Weather | AccuWeather', 'href': 'https://www.accuweather.com/en/jp/tokyo/226396/current-weather/226396', 'body': 'Current weather in Tokyo, Tokyo, Japan. Check current conditions in Tokyo, Tokyo, Japan with radar, hourly, and more.'}, {'title': 'Weather in Tokyo, Japan - timeanddate.com', 'href': 'https://www.timeanddate.com/weather/japan/tokyo', 'body': 'Current weather in Tokyo and forecast for today, tomorrow, and next 14 days'}, {'title': 'Tokyo Weather Forecast Today', 'href': 'https://japanweather.org/tokyo', 'body': "For today's mild weather in Tokyo, with temperatures between 13ºC to 16ºC (55.4ºF to 60.8ºF), consider wearing: - Comfortable jeans or slacks - Sun hat (if spending time outdoors) - Lightweight sweater or cardigan - Long-sleeve shirt or blouse. Temperature. Day. 14°C. Night. 10°C. Morning. 10°C. Afternoon."}] <class 'list'>
+RESULTS in tool ["Tokyo, Tokyo, Japan Weather Forecast, with current conditions, wind, air quality, and what to expect for the next 3 days.\n Citation: https://www.accuweather.com/en/jp/tokyo/226396/weather-forecast/226396\n\n\n\nTokyo Extended Forecast with high and low temperatures. °F. Last 2 weeks of weather\n Citation: https://www.timeanddate.com/weather/japan/tokyo/ext\n\n\n\nCurrent weather in Tokyo, Tokyo, Japan. Check current conditions in Tokyo, Tokyo, Japan with radar, hourly, and more.\n Citation: https://www.accuweather.com/en/jp/tokyo/226396/current-weather/226396\n\n\n\nCurrent weather in Tokyo and forecast for today, tomorrow, and next 14 days\n Citation: https://www.timeanddate.com/weather/japan/tokyo\n\n\n\nFor today's mild weather in Tokyo, with temperatures between 13ºC to 16ºC (55.4ºF to 60.8ºF), consider wearing: - Comfortable jeans or slacks - Sun hat (if spending time outdoors) - Lightweight sweater or cardigan - Long-sleeve shirt or blouse. Temperature. Day. 14°C. Night. 10°C. Morning. 10°C. Afternoon.\n Citation: https://japanweather.org/tokyo\n\n\n", 'https://www.accuweather.com/en/jp/tokyo/226396/weather-forecast/226396\n\nhttps://www.timeanddate.com/weather/japan/tokyo/ext\n\nhttps://www.accuweather.com/en/jp/tokyo/226396/current-weather/226396\n\nhttps://www.timeanddate.com/weather/japan/tokyo\n\nhttps://japanweather.org/tokyo\n']
+The current weather in Tokyo, Japan is mild, with temperatures ranging from 13°C to 16°C (approximately 55.4°F to 60.8°F). For today's conditions, it is suggested to wear comfortable jeans or slacks, a lightweight sweater or cardigan, and a long-sleeve shirt or blouse, especially if spending time outdoors. The temperature today is expected to reach a high of 14°C (57.2°F) during the day and a low of 10°C (50°F) at night.
 
+For more detailed weather information, you can check out the following sources:
+- [AccuWeather Forecast](https://www.accuweather.com/en/jp/tokyo/226396/weather-forecast/226396)
+- [Time and Date Extended Forecast](https://www.timeanddate.com/weather/japan/tokyo/ext)
+- [Current Weather on AccuWeather](https://www.accuweather.com/en/jp/tokyo/226396/current-weather/226396)
+- [More on Time and Date](https://www.timeanddate.com/weather/japan/tokyo)
+- [Japan Weather](https://japanweather.org/tokyo)
+```
 
-Known as the Liberator, Simón Bolívar led revolutions against Spanish rule in South America. The countries of Venezuela, Colombia, Ecuador, Panama, Peru, and Bolivia all owe their independence largely to him. Bolívar was born on July 24, 1783, in Caracas, New Granada (now in Venezuela). After studying in Europe, he returned to South America and began to fight Spanish rule. Between 1810 and 1814 Venezuela made two failed tries to break free from Spain. After the second defeat, Bolívar fled to Jam...
- Citation: https://kids.britannica.com/kids/article/Sim%C3%B3n-Bol%C3%ADvar/352872
 
+### Serving
+To serve an NPC project, first install redis-server and start it
 
+on Ubuntu:
+```bash
+sudo apt update && sudo apt install redis-server
+redis-server
+```
 
-- https://en.wikipedia.org/wiki/Sim%C3%B3n_Bol%C3%ADvar
+on macOS:
+```bash
+brew install redis
+redis-server
+```
+Then navigate to the project directory and run:
 
-https://www.britannica.com/biography/Simon-Bolivar
+```bash
+npc serve
+```
+If you want to specify a certain port, you can do so with the `-p` flag:
+```bash
+npc serve -p 5337
+```
+or with the `--port` flag:
+```bash
+npc serve --port 5337
 
-https://en.wikipedia.org/wiki/File:Sim%C3%B3n_Bol%C3%ADvar_2.jpg
+```
+If you want to initialize a project based on templates and then make it available for serving, you can do so like this
+```bash
+npc serve -t 'sales, marketing' -ctx 'im developing a team that will focus on sales and marketing within the logging industry. I need a team that can help me with the following: - generate leads - create marketing campaigns - build a sales funnel - close deals - manage customer relationships - manage sales pipeline - manage marketing campaigns - manage marketing budget' -m llama3.2 -pr ollama
+```
+This will use the specified model and provider to generate a team of npcs to fit the templates and context provided.
 
-https://www.historytoday.com/archive/simon-bolivar-and-spanish-revolutions
 
-https://kids.britannica.com/kids/article/Sim%C3%B3n-Bol%C3%ADvar/352872
-```
+Once the server is up and running, you can access the API endpoints at `http://localhost:5337/api/`. Here are some example curl commands to test the endpoints:
 
 ```bash
-npc search 'snipers on the roof indiana university' -sp duckduckgo
-```
+echo "Testing health endpoint..."
+curl -s http://localhost:5337/api/health | jq '.'
 
+echo -e "\nTesting execute endpoint..."
+curl -s -X POST http://localhost:5337/api/execute \
+  -H "Content-Type: application/json" \
+  -d '{"commandstr": "hello world", "currentPath": "~/", "conversationId": "test124"}' | jq '.'
 
-### Set: Changing defaults from within npcsh
-Users can change the default model and provider from within npcsh by using the following commands:
-```npcsh
-npcsh> /set model ollama
-npcsh> /set provider llama3.2
+echo -e "\nTesting conversations endpoint..."
+curl -s "http://localhost:5337/api/conversations?path=/tmp" | jq '.'
+
+echo -e "\nTesting conversation messages endpoint..."
+curl -s http://localhost:5337/api/conversation/test123/messages | jq '.'
 ```
 
+###
 
-### Sleep : a method for creating and updating a knowledge graph (under construction)
 
-Use the `/sleep` macro to create or update a knowledge graph. A knowledge graph is a structured representation of facts about you as a user that the NPCs can determine based on the conversations you have had with it.
-```npcsh
-npcsh> /sleep
-```
+* **Planned:** -npc scripts
+-npc run select +sql_model   <run up>
+-npc run select +sql_model+  <run up and down>
+-npc run select sql_model+  <run down>
+-npc run line <assembly_line>
+-npc conjure fabrication_plan.fab
 
-### breathe: a method for condensing context on a regular cadence (# messages, len(context), etc) (under construction)
--every 10 messages/7500 characters, condense the conversation into lessons learned. write the lessons learned down by the np
-for the day, then the npc will see the lessons they have learned that day in that folder as part of the context.
 
 
+## Macros
 
-### Spool
-Spool mode allows one to enter into a conversation with a specific LLM or a specific NPC.
-This is used for having distinct interactions from those in the base shell and these will be separately contained.
+While npcsh can decide the best option to use based on the user's input, the user can also execute certain actions with a macro. Macros are commands within the NPC shell that start with a forward slash (/) and are followed (in some cases) by the relevant arguments for those macros. Each macro is also available as a sub-program within the NPC CLI. In the following examples we demonstrate how to carry out the same operations from within npcsh and from a regular shell.
 
 
-Start the spool mode:
+To learn about the available macros from within the shell, type:
 ```npcsh
-npcsh> /spool
+npcsh> /help
 ```
-Start the spool mode with a specific npc
 
-```npcsh
-npcsh> /spool npc=foreman
+or from bash
+```bash
+npc --help
+#alternatively
+npc -h
 ```
 
-Start the spool mode with specific files in context that will be referenced through RAG searches when relevant.
-
+To exit the shell:
 ```npcsh
-npcsh> /spool files=[*.py,*.md] # Load specific files for context
+npcsh> /exit
 ```
 
-Have a conversation and switch between text and voice mode by invoking `/whisper` mode from within spool mode.
-```npcsh
-spool> what can you tell me about green bull from one piece?
-
-Green Bull, also known as Ryokugyu, is a character from the popular anime and manga series One Piece. He is one of the Marine Admirals and was introduced during the Wano Country arc. Here are some key points about Green
-Bull:
- 1 Real Name: His real name is Aramaki, but he is primarily known by his title, Green Bull (Ryokugyu in Japanese).
- 2 Appearance: Green Bull has a distinct look characterized by a green military uniform, a long cape, and a
-    noticeable plant-based theme, which aligns with his powers.
- 3 Devil Fruit: Green Bull is a user of the Mori Mori no Mi (Forest Forest Fruit), a Logia-type Devil Fruit that
-    allows him to generate and manipulate plant matter. This ability can be seen in his combat style, which utilizes
-    plants to entrap and attack opponents.
- 4 Role as an Admiral: As an Admiral, Green Bull holds a high-ranking position in the Marines and is
-    known for his strength and authority. He is fiercely loyal to the Marine organization and its goals.
- 5 Personality: Green Bull displays a laid-back attitude and often appears more relaxed compared to other Admirals.
-    His personality can be somewhat ambiguous, which adds depth to his character.
- 6 Involvement in the Story: Green Bull's introduction brings anticipation regarding his potential confrontations with
-    key characters in the series. His role in major arcs like Wano and his interactions with the Straw Hat Pirates and
-    other significant figures are crucial for the unfolding storyline.
- Overall, Green Bull is an intriguing character with unique abilities and a significant role within the One Piece universe.
-
-spool> /whisper
-
-Calibrating silence level. Please remain quiet...
-Silence threshold set to: 5679.193548387097
-Listening... (speak now)
-...............
-Max duration reached.
-
-Processing...
-You said: What do you think his greatest weakness is?
-
-
-Based on what we know about Green Bull from the One Piece series, I can identify a few potential weaknesses:
-
-1. **Extreme Laziness**:
-- Green Bull is known for being incredibly lazy, often refusing to move or exert himself unnecessarily.
-- This laziness could be exploited by opponents who understand how to manipulate or provoke him into action.
+Otherwise, here are some more detailed examples of macros that can be used in npcsh:
+### Conjure (under construction)
+Use the `/conjure` macro to generate an NPC, a NPC tool, an assembly line, a job, or an SQL model
 
-2. **Dependency on External Nutrition**:
-- His Devil Fruit power allows him to absorb nutrients from the environment, which suggests he might become weakened in environments with limited plant life or nutrients.
-- In extremely barren or non-vegetative settings, his regenerative and plant-based abilities might be significantly reduced.
+```bash
+npc conjure -n name -t 'templates'
+```
 
-3. **Pride and Marine Ideology**:
-- Like many Marines, he likely has a rigid sense of justice that could be used against him strategically.
-- His commitment to Marine principles might make him predictable in certain confrontational scenarios.
 
-4. **Potential Overconfidence**:
-- As an Admiral, he might underestimate opponents, especially pirates, due to his high-ranking status.
-- His laid-back nature might lead him to not take threats seriously until it's too late.
+### Data Interaction and analysis (under construction)
 
-The most pronounced weakness seems to be his extreme laziness, which could potentially be exploited tactically by skilled opponents who understand how to force him into action or create scenarios that challenge his passive nature.
 
-Here are some additional details about Green Bull (Aramaki) in "One Piece":
+### Debate (under construction)
+Use the `/debate` macro to have two or more NPCs debate a topic, problem, or question.
 
- 1 Devil Fruit Name:
+For example:
+```npcsh
+npcsh> /debate Should humans colonize Mars? npcs = ['sibiji', 'mark', 'ted']
+```
 
- • Green Bull's Devil Fruit has been confirmed to be the Mori Mori no Mi, which is a mythical Zoan-type fruit. This allows him to utilize various forms of plant life in combat and has regenerative
-   capabilities.
 
- 2 Combat Abilities:
 
- • His ability to control vegetation gives him significant advantages in battle. He can generate plants to attack or defend and possibly use them for tactical advantages, such as creating barriers
-   or entangling enemies.
+### Notes
+Jot down notes and store them within the npcsh database and in the current directory as a text file.
+```npcsh
+npcsh> /notes
+```
 
- 3 Reputation:
 
- • As an Admiral, Green Bull holds a position of great power and authority within the Marines. His reputation is likely formidable among pirates and other opponents.
+### Over-the-shoulder: Screenshots and image analysis
 
- 4 Interactions with Other Characters:
+Use the /ots macro to take a screenshot and write a prompt for an LLM to answer about the screenshot.
+```npcsh
+npcsh> /ots
 
- • Green Bull's character dynamics with others in the series, particularly with fellow Marines and pirates, can provide insight into his personality and values. His interactions during missions or
-   discussions about justice will reveal more about his character.
+Screenshot saved to: /home/caug/.npcsh/screenshots/screenshot_1735015011.png
 
- 5 Appearance and Style:
+Enter a prompt for the LLM about this image (or press Enter to skip): describe whats in this image
 
- • He has a rather unique aesthetic, characterized by his green clothing that symbolizes his connection to nature. His overall appearance contributes to his identity as a plant-based fighter.
+The image displays a source control graph, likely from a version control system like Git. It features a series of commits represented by colored dots connected by lines, illustrating the project's development history. Each commit message provides a brief description of the changes made, including tasks like fixing issues, merging pull requests, updating README files, and adjusting code or documentation. Notably, several commits mention specific users, particularly "Chris Agostino," indicating collaboration and contributions to the project. The graph visually represents the branching and merging of code changes.
+```
 
- 6 Backstory:
+In bash:
+```bash
+npc ots
+```
 
- • As of now, specific details about his backstory and how he rose to the rank of Admiral are not extensively explored in the series. This leaves room for further character development and
-   background to be unveiled in future chapters.
 
- 7 Ambiguous Personality:
 
- • While his laziness and laid-back demeanor are evident, it is possible that there are deeper layers to his character that might be revealed through his actions and motivations within the
-   overarching narrative of "One Piece."
+Alternatively, pass an existing image in like :
+```npcsh
+npcsh> /ots test_data/catfight.PNG
+Enter a prompt for the LLM about this image (or press Enter to skip): whats in this ?
 
- 8 Role in the Marine Organization:
+The image features two cats, one calico and one orange tabby, playing with traditional Japanese-style toys. They are each holding sticks attached to colorful pom-pom balls, which resemble birds. The background includes stylized waves and a red sun, accentuating a vibrant, artistic style reminiscent of classic Japanese art. The playful interaction between the cats evokes a lively, whimsical scene.
+```
 
- • His position as Admiral places him in direct opposition to the main pirate characters, particularly the Straw Hat crew, making him a significant figure in the ongoing conflict between pirates
-   and the Marines.
-As the story continues to develop, Green Bull's character may evolve and reveal more complexities, weaknesses, and relationships within the world of "One Piece."
+```bash
+npc ots -f test_data/catfight.PNG
 ```
 
 
-Start the spool with a specific llm model:
+### Plan : Schedule tasks to be run at regular intervals (under construction)
+Use the /plan macro to schedule tasks to be run at regular intervals.
 ```npcsh
-#note this is not yet implemented
-npcsh> /spool model=llama3.3
+npcsh> /plan run a rag search on the files in the current directory every 5 minutes
 ```
 
 ```bash
-npc spool -n npc.npc
+npc plan -f 30m -t 'task'
 ```
 
+### Plonk : Computer Control
+Use the /plonk macro to allow the LLM to control your computer.
+```npcsh
+npcsh> /plonk go to a web browser and  go to wikipedia and find out information about simon bolivar
+```
 
+```bash
+npc plonk 'use a web browser to find out information about simon boliver'
+```
 
-### Vixynt: Image Generation
-Image generation can be done with the /vixynt macro.
+### RAG
 
-Use /vixynt like so where you can also specify the model to use with an @ reference. This @ reference will override the default model in ~/.npcshrc.
+Use the /rag macro to perform a local rag search.
+If you pass a `-f` flag with a filename or list of filenames (e.g. *.py) then it will embed the documents and perform the cosine similarity scoring.
 
 ```npcsh
-npcsh> /vixynt A futuristic cityscape @dall-e-3
+npcsh> /rag -f *.py  what is the best way to implement a linked list in Python?
 ```
-![futuristic cityscape](test_data/futuristic_cityscape.PNG)
 
+Alternatively , if you want to perform rag on your past conversations, you can do so like this:
 ```npcsh
-npcsh> /vixynt A peaceful landscape @runwayml/stable-diffusion-v1-5
+npcsh> /rag  what is the best way to implement a linked list in Python?
 ```
-![peaceful landscape](test_data/peaceful_landscape_stable_diff.png)
+and it will automatically look through the recorded conversations in the ~/npcsh_history.db
 
 
-Similarly, use vixynt with the NPC CLI from a regular shell:
+In bash:
 ```bash
-$ npc --model 'dall-e-2' --provider 'openai' vixynt 'whats a french man to do in the southern bayeaux'
+npc rag -f *.py
 ```
 
+### Rehash
 
-
-
-### Whisper: Voice Control
-Enter into a voice-controlled mode to interact with the LLM. This mode can executet commands and use tools just like the basic npcsh shell.
+Use the /rehash macro to re-send the last message to the LLM.
 ```npcsh
-npcsh> /whisper
+npcsh> /rehash
 ```
 
-
-
-
-### Compilation and NPC Interaction
-Compile a specified NPC profile. This will make it available for use in npcsh interactions.
+### Sample
+Send a one-shot question to the LLM.
 ```npcsh
-npcsh> /compile <npc_file>
+npcsh> /sample What is the capital of France?
 ```
-You can also use `/com` as an alias for `/compile`. If no NPC file is specified, all NPCs in the npc_team directory will be compiled.
 
-Begin a conversations with a specified NPC by referencing their name
-```npcsh
-npcsh> /<npc_name>:
+Bash:
+```bash
+npc sample 'thing' -m model -p provider
+
 ```
 
 
+### Search
+Search can be accomplished through the `/search` macro. You can specify the provider as being "perplexity" or "duckduckgo". For the former,
+you must set a perplexity api key as an environment variable as described above. The default provider is duckduckgo.
 
-## NPC Data Layer
+NOTE: while google is an available search engine, they recently implemented changes (early 2025) that make the python google search package no longer as reliable.
+For now, we will use duckduckgo and revisit this issue when other more critical aspects are handled.
 
-What principally powers the capabilities of npcsh is the NPC Data Layer. In the `~/.npcsh/` directory after installation, you will find
-the npc teaam with its tools, models, contexts, assembly lines, and NPCs. By making tools, NPCs, contexts, and assembly lines simple data structures with
-a fixed set of parameters, we can let users define them in easy-to-read YAML files, allowing for a modular and extensible system that can be easily modified and expanded upon. Furthermore, this data layer relies heavily on jinja templating to allow for dynamic content generation and the ability to reference other NPCs, tools, and assembly lines in the system.
 
-### Creating NPCs
-NPCs are defined in YAML files within the npc_team directory. Each NPC must have a name and a primary directive. Optionally, one can specify an LLM model/provider for the NPC as well as provide an explicit list of tools and whether or not to use the globally available tools. See the data models contained in `npcsh/data_models.py` for more explicit type details on the NPC data structure.
+```npcsh
+npcsh!> /search -p duckduckgo  who is the current us president
 
 
+President Donald J. Trump entered office on January 20, 2025. News, issues, and photos of the President Footer Disclaimer This is the official website of the U.S. Mission to the United Nations. External links to other Internet sites should not be construed as an endorsement of the views or privacy policies contained therein.
 
-Here is a typical NPC file:
-```yaml
-name: sibiji
-primary_directive: You are a foundational AI assistant. Your role is to provide basic support and information. Respond to queries concisely and accurately.
-tools:
-  - simple data retrieval
-model: llama3.2
-provider: ollama
+Citation: https://usun.usmission.gov/our-leaders/the-president-of-the-united-states/
+45th & 47th President of the United States After a landslide election victory in 2024, President Donald J. Trump is returning to the White House to build upon his previous successes and use his mandate to reject the extremist policies of the radical left while providing tangible quality of life improvements for the American people. Vice President of the United States In 2024, President Donald J. Trump extended JD the incredible honor of asking him to serve as the Vice-Presidential Nominee for th...
+Citation: https://www.whitehouse.gov/administration/
+Citation: https://www.instagram.com/potus/?hl=en
+The president of the United States (POTUS)[B] is the head of state and head of government of the United States. The president directs the executive branch of the federal government and is the commander-in-chief of the United States Armed Forces. The power of the presidency has grown substantially[12] since the first president, George Washington, took office in 1789.[6] While presidential power has ebbed and flowed over time, the presidency has played an increasingly significant role in American ...
+Citation: https://en.wikipedia.org/wiki/President_of_the_United_States
+Citation Links: https://usun.usmission.gov/our-leaders/the-president-of-the-united-states/
+https://www.whitehouse.gov/administration/
+https://www.instagram.com/potus/?hl=en
+https://en.wikipedia.org/wiki/President_of_the_United_States
 ```
 
 
-## Creating Tools
-Tools are defined as YAMLs with `.tool` extension within the npc_team/tools directory. Each tool has a name, inputs, and consists of three distinct steps: preprocess, prompt, and postprocess. The idea here is that a tool consists of a stage where information is preprocessed and then passed to a prompt for some kind of analysis and then can be passed to another stage for postprocessing. In each of these three cases, the engine must be specified. The engine can be either "natural" for natural language processing or "python" for Python code. The code is the actual code that will be executed.
+```npcsh
+npcsh> /search -p perplexity who is the current us president
+The current President of the United States is Donald Trump, who assumed office on January 20, 2025, for his second non-consecutive term as the 47th president[1].
 
-Here is an example of a tool file:
-```yaml
-tool_name: "screen_capture_analysis_tool"
-inputs:
-  - "prompt"
-preprocess:
-  - engine: "python"
-    code: |
-      # Capture the screen
-      import pyautogui
-      import datetime
-      import os
-      from PIL import Image
-      from npcsh.image import analyze_image_base
-
-      # Generate filename
-      filename = f"screenshot_{datetime.datetime.now().strftime('%Y%m%d_%H%M%S')}.png"
-      screenshot = pyautogui.screenshot()
-      screenshot.save(filename)
-      print(f"Screenshot saved as {filename}")
-
-      # Load image
-      image = Image.open(filename)
-
-      # Full file path
-      file_path = os.path.abspath('./'+filename)
-      # Analyze the image
-
-      llm_output = analyze_image_base(inputs['prompt']+ '\n\n attached is a screenshot of my screen currently.', file_path, filename, npc=npc)
-prompt:
-  engine: "natural"
-  code: ""
-postprocess:
-  - engine: "natural"
-    code: |
-      Screenshot captured and saved as {{ filename }}.
-      Analysis Result: {{ llm_output }}
+Citation Links: ['https://en.wikipedia.org/wiki/List_of_presidents_of_the_United_States',
+'https://en.wikipedia.org/wiki/Joe_Biden',
+'https://www.britannica.com/topic/Presidents-of-the-United-States-1846696',
+'https://news.gallup.com/poll/329384/presidential-approval-ratings-joe-biden.aspx',
+'https://www.usa.gov/presidents']
 ```
 
+Bash:
 
-When you have created a tool, it will be surfaced as a potential option to be used when you ask a question in the base npcsh shell. The LLM will decide if it is the best tool to use based on the user's input. Alternatively, if you'd like, you can call the tools directly, without needing to let the AI decide if it's the right one to use.
-
-  ```npcsh
-  npcsh> /screen_cap_tool <prompt>
-  ```
-  or
-  ```npcsh
-  npcsh> /sql_executor select * from conversation_history limit 1
-
-  ```
-  or
-  ```npcsh
-  npcsh> /calculator 5+6
-  ```
-
+```bash
+(npcsh) caug@pop-os:~/npcww/npcsh$ npc search 'simon bolivar' -sp perplexity
+Loaded .env file from /home/caug/npcww/npcsh
+urls ['https://en.wikipedia.org/wiki/Sim%C3%B3n_Bol%C3%ADvar', 'https://www.britannica.com/biography/Simon-Bolivar', 'https://en.wikipedia.org/wiki/File:Sim%C3%B3n_Bol%C3%ADvar_2.jpg', 'https://www.historytoday.com/archive/simon-bolivar-and-spanish-revolutions', 'https://kids.britannica.com/kids/article/Sim%C3%B3n-Bol%C3%ADvar/352872']
+openai
+- Simón José Antonio de la Santísima Trinidad Bolívar Palacios Ponte y Blanco[c] (24 July 1783 – 17 December 1830) was a Venezuelan statesman and military officer who led what are currently the countries of Colombia, Venezuela, Ecuador, Peru, Panama, and Bolivia to independence from the Spanish Empire. He is known colloquially as El Libertador, or the Liberator of America. Simón Bolívar was born in Caracas in the Captaincy General of Venezuela into a wealthy family of American-born Spaniards (crio...
+ Citation: https://en.wikipedia.org/wiki/Sim%C3%B3n_Bol%C3%ADvar
 
-## NPC Pipelines
 
 
+Our editors will review what you’ve submitted and determine whether to revise the article. Simón Bolívar was a Venezuelan soldier and statesman who played a central role in the South American independence movement. Bolívar served as president of Gran Colombia (1819–30) and as dictator of Peru (1823–26). The country of Bolivia is named for him. Simón Bolívar was born on July 24, 1783, in Caracas, Venezuela. Neither Bolívar’s aristocrat father nor his mother lived to see his 10th birthday. Bolívar...
+ Citation: https://www.britannica.com/biography/Simon-Bolivar
 
-Let's say you want to create a pipeline of steps where NPCs are used along the way. Let's initialize with a pipeline file we'll call `morning_routine.pipe`:
-```yaml
-steps:
-  - step_name: "review_email"
-    npc: "{{ ref('email_assistant') }}"
-    task: "Get me up to speed on my recent emails: {{source('emails')}}."
 
 
-  - step_name: "market_update"
-    npc: "{{ ref('market_analyst') }}"
-    task: "Give me an update on the latest events in the market: {{source('market_events')}}."
+Original file (1,525 × 1,990 pixels, file size: 3.02 MB, MIME type: image/jpeg) Derivative works of this file: Simón Bolívar 5.jpg This work is in the public domain in its country of origin and other countries and areas where the copyright term is the author's life plus 100 years or fewer. This work is in the public domain in the United States because it was published (or registered with the U.S. Copyright Office) before January 1, 1930. https://creativecommons.org/publicdomain/mark/1.0/PDMCreat...
+ Citation: https://en.wikipedia.org/wiki/File:Sim%C3%B3n_Bol%C3%ADvar_2.jpg
 
-  - step_name: "summarize"
-    npc: "{{ ref('sibiji') }}"
-    model: llama3.2
-    provider: ollama
-    task: "Review the outputs from the {{review_email}} and {{market_update}} and provide me with a summary."
 
-```
-Now youll see that we reference NPCs in the pipeline file. We'll need to make sure we have each of those NPCs available.
-Here is an example for the email assistant:
-```yaml
-name: email_assistant
-primary_directive: You are an AI assistant specialized in managing and summarizing emails. You should present the information in a clear and concise manner.
-model: gpt-4o-mini
-provider: openai
-```
-Now for the marketing analyst:
-```yaml
-name: market_analyst
-primary_directive: You are an AI assistant focused on monitoring and analyzing market trends. Provide de
-model: llama3.2
-provider: ollama
-```
-and then here is our trusty friend sibiji:
-```yaml
-name: sibiji
-primary_directive: You are a foundational AI assistant. Your role is to provide basic support and information. Respond to queries concisely and accurately.
-suggested_tools_to_use:
-  - simple data retrieval
-model: claude-3-5-sonnet-latest
-provider: anthropic
-```
-Now that we have our pipeline and NPCs defined, we also need to ensure that the source data we are referencing will be there. When we use source('market_events') and source('emails') we are asking npcsh to pull those data directly from tables in our npcsh database. For simplicity we will just make these in python to insert them for this demo:
-```python
-import pandas as pd
-from sqlalchemy import create_engine
-import os
 
-# Sample market events data
-market_events_data = {
-    "datetime": [
-        "2023-10-15 09:00:00",
-        "2023-10-16 10:30:00",
-        "2023-10-17 11:45:00",
-        "2023-10-18 13:15:00",
-        "2023-10-19 14:30:00",
-    ],
-    "headline": [
-        "Stock Market Rallies Amid Positive Economic Data",
-        "Tech Giant Announces New Product Line",
-        "Federal Reserve Hints at Interest Rate Pause",
-        "Oil Prices Surge Following Supply Concerns",
-        "Retail Sector Reports Record Q3 Earnings",
-    ],
-}
+SubscriptionOffers Give a Gift Subscribe A map of Gran Colombia showing the 12 departments created in 1824 and territories disputed with neighboring countries. What role did Simon Bolivar play in the history of Latin America's independence from Spain? Simon Bolivar lived a short but comprehensive life. History records his extraordinary versatility. He was a revolutionary who freed six countries, an intellectual who argued the problems of national liberation, a general who fought a war of unremit...
+ Citation: https://www.historytoday.com/archive/simon-bolivar-and-spanish-revolutions
 
-# Create a DataFrame
-market_events_df = pd.DataFrame(market_events_data)
 
-# Define database path relative to user's home directory
-db_path = os.path.expanduser("~/npcsh_history.db")
 
-# Create a connection to the SQLite database
-engine = create_engine(f"sqlite:///{db_path}")
-with engine.connect() as connection:
-    # Write the data to a new table 'market_events', replacing existing data
-    market_events_df.to_sql(
-        "market_events", con=connection, if_exists="replace", index=False
-    )
+Known as the Liberator, Simón Bolívar led revolutions against Spanish rule in South America. The countries of Venezuela, Colombia, Ecuador, Panama, Peru, and Bolivia all owe their independence largely to him. Bolívar was born on July 24, 1783, in Caracas, New Granada (now in Venezuela). After studying in Europe, he returned to South America and began to fight Spanish rule. Between 1810 and 1814 Venezuela made two failed tries to break free from Spain. After the second defeat, Bolívar fled to Jam...
+ Citation: https://kids.britannica.com/kids/article/Sim%C3%B3n-Bol%C3%ADvar/352872
 
-print("Market events have been added to the database.")
 
-email_data = {
-    "datetime": [
-        "2023-10-10 10:00:00",
-        "2023-10-11 11:00:00",
-        "2023-10-12 12:00:00",
-        "2023-10-13 13:00:00",
-        "2023-10-14 14:00:00",
-    ],
-    "subject": [
-        "Meeting Reminder",
-        "Project Update",
-        "Invoice Attached",
-        "Weekly Report",
-        "Holiday Notice",
-    ],
-    "sender": [
-        "alice@example.com",
-        "bob@example.com",
-        "carol@example.com",
-        "dave@example.com",
-        "eve@example.com",
-    ],
-    "recipient": [
-        "bob@example.com",
-        "carol@example.com",
-        "dave@example.com",
-        "eve@example.com",
-        "alice@example.com",
-    ],
-    "body": [
-        "Don't forget the meeting tomorrow at 10 AM.",
-        "The project is progressing well, see attached update.",
-        "Please find your invoice attached.",
-        "Here is the weekly report.",
-        "The office will be closed on holidays, have a great time!",
-    ],
-}
 
-# Create a DataFrame
-emails_df = pd.DataFrame(email_data)
+- https://en.wikipedia.org/wiki/Sim%C3%B3n_Bol%C3%ADvar
 
-# Define database path relative to user's home directory
-db_path = os.path.expanduser("~/npcsh_history.db")
+https://www.britannica.com/biography/Simon-Bolivar
 
-# Create a connection to the SQLite database
-engine = create_engine(f"sqlite:///{db_path}")
-with engine.connect() as connection:
-    # Write the data to a new table 'emails', replacing existing data
-    emails_df.to_sql("emails", con=connection, if_exists="replace", index=False)
+https://en.wikipedia.org/wiki/File:Sim%C3%B3n_Bol%C3%ADvar_2.jpg
 
-print("Sample emails have been added to the database.")
+https://www.historytoday.com/archive/simon-bolivar-and-spanish-revolutions
 
+https://kids.britannica.com/kids/article/Sim%C3%B3n-Bol%C3%ADvar/352872
 ```
 
+```bash
+npc search 'snipers on the roof indiana university' -sp duckduckgo
+```
 
-With these data now in place, we can proceed with running the pipeline. We can do this in npcsh by using the /compile command.
 
+### Set: Changing defaults from within npcsh
+Users can change the default model and provider from within npcsh by using the following commands:
+```npcsh
+npcsh> /set model ollama
+npcsh> /set provider llama3.2
+```
 
 
+### Sleep : a method for creating and updating a knowledge graph (under construction)
 
+Use the `/sleep` macro to create or update a knowledge graph. A knowledge graph is a structured representation of facts about you as a user that the NPCs can determine based on the conversations you have had with it.
 ```npcsh
-npcsh> /compile morning_routine.pipe
+npcsh> /sleep
 ```
 
+### breathe: a method for condensing context on a regular cadence (# messages, len(context), etc) (under construction)
+-every 10 messages/7500 characters, condense the conversation into lessons learned. write the lessons learned down by the np
+for the day, then the npc will see the lessons they have learned that day in that folder as part of the context.
 
 
-Alternatively we can run a pipeline like so in Python:
 
-```bash
-from npcsh.npc_compiler import PipelineRunner
-import os
+### Spool
+Spool mode allows one to enter into a conversation with a specific LLM or a specific NPC.
+This is used for having distinct interactions from those in the base shell and these will be separately contained.
 
-pipeline_runner = PipelineRunner(
-    pipeline_file="morning_routine.pipe",
-    npc_root_dir=os.path.abspath("./"),
-    db_path="~/npcsh_history.db",
-)
-pipeline_runner.execute_pipeline(inputs)
-```
 
-What if you wanted to run operations on each row and some operations on all the data at once? We can do this with the pipelines as well. Here we will build a pipeline for news article analysis.
-First we make the data for the pipeline that well use:
-```python
-import pandas as pd
-from sqlalchemy import create_engine
-import os
+Start the spool mode:
+```npcsh
+npcsh> /spool
+```
+Start the spool mode with a specific npc
 
-# Sample data generation for news articles
-news_articles_data = {
-    "news_article_id": list(range(1, 21)),
-    "headline": [
-        "Economy sees unexpected growth in Q4",
-        "New tech gadget takes the world by storm",
-        "Political debate heats up over new policy",
-        "Health concerns rise amid new disease outbreak",
-        "Sports team secures victory in last minute",
-        "New economic policy introduced by government",
-        "Breakthrough in AI technology announced",
-        "Political leader delivers speech on reforms",
-        "Healthcare systems pushed to limits",
-        "Celebrated athlete breaks world record",
-        "Controversial economic measures spark debate",
-        "Innovative tech startup gains traction",
-        "Political scandal shakes administration",
-        "Healthcare workers protest for better pay",
-        "Major sports event postponed due to weather",
-        "Trade tensions impact global economy",
-        "Tech company accused of data breach",
-        "Election results lead to political upheaval",
-        "Vaccine developments offer hope amid pandemic",
-        "Sports league announces return to action",
-    ],
-    "content": ["Article content here..." for _ in range(20)],
-    "publication_date": pd.date_range(start="1/1/2023", periods=20, freq="D"),
-}
+```npcsh
+npcsh> /spool npc=foreman
 ```
 
-Then we will create the pipeline file:
-```yaml
-# news_analysis.pipe
-steps:
-  - step_name: "classify_news"
-    npc: "{{ ref('news_assistant') }}"
-    task: |
-      Classify the following news articles into one of the categories:
-      ["Politics", "Economy", "Technology", "Sports", "Health"].
-      {{ source('news_articles') }}
+Start the spool mode with specific files in context that will be referenced through RAG searches when relevant.
 
-  - step_name: "analyze_news"
-    npc: "{{ ref('news_assistant') }}"
-    batch_mode: true  # Process articles with knowledge of their tags
-    task: |
-      Based on the category assigned in {{classify_news}}, provide an in-depth
-      analysis and perspectives on the article. Consider these aspects:
-      ["Impacts", "Market Reaction", "Cultural Significance", "Predictions"].
-      {{ source('news_articles') }}
+```npcsh
+npcsh> /spool files=[*.py,*.md] # Load specific files for context
 ```
 
-Then we can run the pipeline like so:
-```bash
-/compile ./npc_team/news_analysis.pipe
-```
-or in python like:
+Have a conversation and switch between text and voice mode by invoking `/whisper` mode from within spool mode.
+```npcsh
+spool> what can you tell me about green bull from one piece?
 
-```bash
+Green Bull, also known as Ryokugyu, is a character from the popular anime and manga series One Piece. He is one of the Marine Admirals and was introduced during the Wano Country arc. Here are some key points about Green
+Bull:
+ 1 Real Name: His real name is Aramaki, but he is primarily known by his title, Green Bull (Ryokugyu in Japanese).
+ 2 Appearance: Green Bull has a distinct look characterized by a green military uniform, a long cape, and a
+    noticeable plant-based theme, which aligns with his powers.
+ 3 Devil Fruit: Green Bull is a user of the Mori Mori no Mi (Forest Forest Fruit), a Logia-type Devil Fruit that
+    allows him to generate and manipulate plant matter. This ability can be seen in his combat style, which utilizes
+    plants to entrap and attack opponents.
+ 4 Role as an Admiral: As an Admiral, Green Bull holds a high-ranking position in the Marines and is
+    known for his strength and authority. He is fiercely loyal to the Marine organization and its goals.
+ 5 Personality: Green Bull displays a laid-back attitude and often appears more relaxed compared to other Admirals.
+    His personality can be somewhat ambiguous, which adds depth to his character.
+ 6 Involvement in the Story: Green Bull's introduction brings anticipation regarding his potential confrontations with
+    key characters in the series. His role in major arcs like Wano and his interactions with the Straw Hat Pirates and
+    other significant figures are crucial for the unfolding storyline.
+ Overall, Green Bull is an intriguing character with unique abilities and a significant role within the One Piece universe.
 
-from npcsh.npc_compiler import PipelineRunner
-import os
-runner = PipelineRunner(
-    "./news_analysis.pipe",
-    db_path=os.path.expanduser("~/npcsh_history.db"),
-    npc_root_dir=os.path.abspath("."),
-)
-results = runner.execute_pipeline()
-```
+spool> /whisper
 
-Alternatively, if youd like to use a mixture of agents in your pipeline, set one up like this:
-```yaml
-steps:
-  - step_name: "classify_news"
-    npc: "news_assistant"
-    mixa: true
-    mixa_agents:
-      - "{{ ref('news_assistant') }}"
-      - "{{ ref('journalist_npc') }}"
-      - "{{ ref('data_scientist_npc') }}"
-    mixa_voters:
-      - "{{ ref('critic_npc') }}"
-      - "{{ ref('editor_npc') }}"
-      - "{{ ref('researcher_npc') }}"
-    mixa_voter_count: 5
-    mixa_turns: 3
-    mixa_strategy: "vote"
-    task: |
-      Classify the following news articles...
-      {{ source('news_articles') }}
-```
-You'll have to make npcs for these references to work, here are versions that should work with the above:
-```yaml
-name: news_assistant
-```
-Then, we can run the mixture of agents method like:
+Calibrating silence level. Please remain quiet...
+Silence threshold set to: 5679.193548387097
+Listening... (speak now)
+...............
+Max duration reached.
 
-```bash
-/compile ./npc_team/news_analysis_mixa.pipe
-```
-or in python like:
+Processing...
+You said: What do you think his greatest weakness is?
 
-```bash
 
-from npcsh.npc_compiler import PipelineRunner
-import os
+Based on what we know about Green Bull from the One Piece series, I can identify a few potential weaknesses:
 
-runner = PipelineRunner(
-    "./news_analysis_mixa.pipe",
-    db_path=os.path.expanduser("~/npcsh_history.db"),
-    npc_root_dir=os.path.abspath("."),
-)
-results = runner.execute_pipeline()
-```
+1. **Extreme Laziness**:
+- Green Bull is known for being incredibly lazy, often refusing to move or exert himself unnecessarily.
+- This laziness could be exploited by opponents who understand how to manipulate or provoke him into action.
 
+2. **Dependency on External Nutrition**:
+- His Devil Fruit power allows him to absorb nutrients from the environment, which suggests he might become weakened in environments with limited plant life or nutrients.
+- In extremely barren or non-vegetative settings, his regenerative and plant-based abilities might be significantly reduced.
 
+3. **Pride and Marine Ideology**:
+- Like many Marines, he likely has a rigid sense of justice that could be used against him strategically.
+- His commitment to Marine principles might make him predictable in certain confrontational scenarios.
 
-Note, in the future we will aim to separate compilation and running so that we will have a compilation step that is more like a jinja rendering of the relevant information so that it can be more easily audited.
+4. **Potential Overconfidence**:
+- As an Admiral, he might underestimate opponents, especially pirates, due to his high-ranking status.
+- His laid-back nature might lead him to not take threats seriously until it's too late.
 
+The most pronounced weakness seems to be his extreme laziness, which could potentially be exploited tactically by skilled opponents who understand how to force him into action or create scenarios that challenge his passive nature.
 
-## Python Examples
-Integrate npcsh into your Python projects for additional flexibility. Below are a few examples of how to use the library programmatically.
+Here are some additional details about Green Bull (Aramaki) in "One Piece":
 
+ 1 Devil Fruit Name:
 
+ • Green Bull's Devil Fruit has been confirmed to be the Mori Mori no Mi, which is a mythical Zoan-type fruit. This allows him to utilize various forms of plant life in combat and has regenerative
+   capabilities.
 
-### Example 1: Creating and Using an NPC
-This example shows how to create and initialize an NPC and use it to answer a question.
-```bash
-import sqlite3
-from npcsh.npc_compiler import NPC
+ 2 Combat Abilities:
 
-# Set up database connection
-db_path = '~/npcsh_history.db'
-conn = sqlite3.connect(db_path)
+ • His ability to control vegetation gives him significant advantages in battle. He can generate plants to attack or defend and possibly use them for tactical advantages, such as creating barriers
+   or entangling enemies.
 
-# Load NPC from a file
-npc = NPC(db_conn=conn,
-          name='Simon Bolivar',
-          primary_directive='Liberate South America from the Spanish Royalists.',
-          model='gpt-4o-mini',
-          provider='openai',
-          )
+ 3 Reputation:
 
-response = npc.get_llm_response("What is the most important territory to retain in the Andes mountains?")
-print(response['response'])
-```
-```bash
-'The most important territory to retain in the Andes mountains for the cause of liberation in South America would be the region of Quito in present-day Ecuador. This area is strategically significant due to its location and access to key trade routes. It also acts as a vital link between the northern and southern parts of the continent, influencing both military movements and the morale of the independence struggle. Retaining control over Quito would bolster efforts to unite various factions in the fight against Spanish colonial rule across the Andean states.'
-```
-### Example 2: Using an NPC to Analyze Data
-This example shows how to use an NPC to perform data analysis on a DataFrame using LLM commands.
-```bash
-from npcsh.npc_compiler import NPC
-import sqlite3
-import os
-# Set up database connection
-db_path = '~/npcsh_history.db'
-conn = sqlite3.connect(os.path.expanduser(db_path))
+ • As an Admiral, Green Bull holds a position of great power and authority within the Marines. His reputation is likely formidable among pirates and other opponents.
 
-# make a table to put into npcsh_history.db or change this example to use an existing table in a database you have
-import pandas as pd
-data = {
-        'customer_feedback': ['The product is great!', 'The service was terrible.', 'I love the new feature.'],
-        'customer_id': [1, 2, 3],
-        'customer_rating': [5, 1, 3],
-        'timestamp': ['2022-01-01', '2022-01-02', '2022-01-03']
-        }
+ 4 Interactions with Other Characters:
 
+ • Green Bull's character dynamics with others in the series, particularly with fellow Marines and pirates, can provide insight into his personality and values. His interactions during missions or
+   discussions about justice will reveal more about his character.
 
-df = pd.DataFrame(data)
-df.to_sql('customer_feedback', conn, if_exists='replace', index=False)
+ 5 Appearance and Style:
 
+ • He has a rather unique aesthetic, characterized by his green clothing that symbolizes his connection to nature. His overall appearance contributes to his identity as a plant-based fighter.
 
-npc = NPC(db_conn=conn,
-          name='Felix',
-          primary_directive='Analyze customer feedback for sentiment.',
-          model='llama3.2',
-          provider='ollama',
-          )
-response = npc.analyze_db_data('Provide a detailed report on the data contained in the `customer_feedback` table?')
+ 6 Backstory:
+
+ • As of now, specific details about his backstory and how he rose to the rank of Admiral are not extensively explored in the series. This leaves room for further character development and
+   background to be unveiled in future chapters.
+
+ 7 Ambiguous Personality:
+
+ • While his laziness and laid-back demeanor are evident, it is possible that there are deeper layers to his character that might be revealed through his actions and motivations within the
+   overarching narrative of "One Piece."
 
+ 8 Role in the Marine Organization:
 
+ • His position as Admiral places him in direct opposition to the main pirate characters, particularly the Straw Hat crew, making him a significant figure in the ongoing conflict between pirates
+   and the Marines.
+As the story continues to develop, Green Bull's character may evolve and reveal more complexities, weaknesses, and relationships within the world of "One Piece."
 ```
 
 
-### Example 3: Creating and Using a Tool
-You can define a tool and execute it from within your Python script.
-Here we'll create a tool that will take in a pdf file, extract the text, and then answer a user request about the text.
+Start the spool with a specific llm model:
+```npcsh
+#note this is not yet implemented
+npcsh> /spool model=llama3.3
+```
 
 ```bash
-from npcsh.npc_compiler import Tool, NPC
-import sqlite3
-import os
-
-tool_data = {
-    "tool_name": "pdf_analyzer",
-    "inputs": ["request", "file"],
-    "steps": [{  # Make this a list with one dict inside
-        "engine": "python",
-        "code": """
-try:
-    import fitz  # PyMuPDF
+npc spool -n npc.npc
+```
 
-    shared_context = {}
-    shared_context['inputs'] = inputs
 
-    pdf_path = inputs['file']
-    print(f"Processing PDF file: {pdf_path}")
 
-    # Open the PDF
-    doc = fitz.open(pdf_path)
-    text = ""
+### Vixynt: Image Generation
+Image generation can be done with the /vixynt macro.
 
-    # Extract text from each page
-    for page_num in range(len(doc)):
-        page = doc[page_num]
-        text += page.get_text()
+Use /vixynt like so where you can also specify the model to use with an @ reference. This @ reference will override the default model in ~/.npcshrc.
 
-    # Close the document
-    doc.close()
+```npcsh
+npcsh> /vixynt A futuristic cityscape @dall-e-3
+```
+![futuristic cityscape](test_data/futuristic_cityscape.PNG)
 
-    print(f"Extracted text length: {len(text)}")
-    if len(text) > 100:
-        print(f"First 100 characters: {text[:100]}...")
+```npcsh
+npcsh> /vixynt A peaceful landscape @runwayml/stable-diffusion-v1-5
+```
+![peaceful landscape](test_data/peaceful_landscape_stable_diff.png)
 
-    shared_context['extracted_text'] = text
-    print("Text extraction completed successfully")
 
-except Exception as e:
-    error_msg = f"Error processing PDF: {str(e)}"
-    print(error_msg)
-    shared_context['extracted_text'] = f"Error: {error_msg}"
-"""
-    },
-     {
-        "engine": "natural",
-        "code": """
-{% if shared_context and shared_context.extracted_text %}
-{% if shared_context.extracted_text.startswith('Error:') %}
-{{ shared_context.extracted_text }}
-{% else %}
-Here is the text extracted from the PDF:
+Similarly, use vixynt with the NPC CLI from a regular shell:
+```bash
+$ npc --model 'dall-e-2' --provider 'openai' vixynt 'whats a french man to do in the southern bayeaux'
+```
 
-{{ shared_context.extracted_text }}
 
-Please provide a response to user request: {{ inputs.request }} using the information extracted above.
-{% endif %}
-{% else %}
-Error: No text was extracted from the PDF.
-{% endif %}
-"""
-    },]
 
-# Instantiate the tool
-tool = Tool(tool_data)
 
-# Create an NPC instance
-npc = NPC(
-    name='starlana',
-    primary_directive='Analyze text from Astrophysics papers with a keen attention to theoretical machinations and mechanisms.',
-    db_conn=sqlite3.connect(os.path.expanduser('~/npcsh_database.db'))
-)
+### Whisper: Voice Control
+Enter into a voice-controlled mode to interact with the LLM. This mode can executet commands and use tools just like the basic npcsh shell.
+```npcsh
+npcsh> /whisper
+```
 
-# Define input values dictionary
-input_values = {
-    "request": "what is the point of the yuan and narayanan work?",
-    "file": os.path.abspath("test_data/yuan2004.pdf")
-}
 
-print(f"Attempting to read file: {input_values['file']}")
-print(f"File exists: {os.path.exists(input_values['file'])}")
 
-# Execute the tool
-output = tool.execute(input_values, npc.tools_dict, None, 'Sample Command', npc)
 
-print('Tool Output:', output)
+### Compilation and NPC Interaction
+Compile a specified NPC profile. This will make it available for use in npcsh interactions.
+```npcsh
+npcsh> /compile <npc_file>
 ```
+You can also use `/com` as an alias for `/compile`. If no NPC file is specified, all NPCs in the npc_team directory will be compiled.
 
-### Example 4: Orchestrating a team
-
-
+Begin a conversations with a specified NPC by referencing their name
+```npcsh
+npcsh> /<npc_name>:
+```
 
-```python
-import pandas as pd
-import numpy as np
-import os
-from npcsh.npc_compiler import NPC, NPCTeam, Tool
 
 
-# Create test data and save to CSV
-def create_test_data(filepath="sales_data.csv"):
-    sales_data = pd.DataFrame(
-        {
-            "date": pd.date_range(start="2024-01-01", periods=90),
-            "revenue": np.random.normal(10000, 2000, 90),
-            "customer_count": np.random.poisson(100, 90),
-            "avg_ticket": np.random.normal(100, 20, 90),
-            "region": np.random.choice(["North", "South", "East", "West"], 90),
-            "channel": np.random.choice(["Online", "Store", "Mobile"], 90),
-        }
-    )
+## NPC Data Layer
 
-    # Add patterns to make data more realistic
-    sales_data["revenue"] *= 1 + 0.3 * np.sin(
-        np.pi * np.arange(90) / 30
-    )  # Seasonal pattern
-    sales_data.loc[sales_data["channel"] == "Mobile", "revenue"] *= 1.1  # Mobile growth
-    sales_data.loc[
-        sales_data["channel"] == "Online", "customer_count"
-    ] *= 1.2  # Online customer growth
+What principally powers the capabilities of npcsh is the NPC Data Layer. In the `~/.npcsh/` directory after installation, you will find
+the npc teaam with its tools, models, contexts, assembly lines, and NPCs. By making tools, NPCs, contexts, and assembly lines simple data structures with
+a fixed set of parameters, we can let users define them in easy-to-read YAML files, allowing for a modular and extensible system that can be easily modified and expanded upon. Furthermore, this data layer relies heavily on jinja templating to allow for dynamic content generation and the ability to reference other NPCs, tools, and assembly lines in the system.
 
-    sales_data.to_csv(filepath, index=False)
-    return filepath, sales_data
+### Creating NPCs
+NPCs are defined in YAML files within the npc_team directory. Each NPC must have a name and a primary directive. Optionally, one can specify an LLM model/provider for the NPC as well as provide an explicit list of tools and whether or not to use the globally available tools. See the data models contained in `npcsh/data_models.py` for more explicit type details on the NPC data structure.
 
 
-code_execution_tool = Tool(
-    {
-        "tool_name": "execute_code",
-        "description": """Executes a Python code block with access to pandas,
-                          numpy, and matplotlib.
-                          Results should be stored in the 'results' dict to be returned.
-                          The only input should be a single code block with \n characters included.
-                          The code block must use only the  libraries or methods contained withen the
-                            pandas, numpy, and matplotlib libraries or using builtin methods.
-                          do not include any json formatting or markdown formatting.
 
-                          When generating your script, the final output must be encoded in a variable
-                          named "output". e.g.
+Here is a typical NPC file:
+```yaml
+name: sibiji
+primary_directive: You are a foundational AI assistant. Your role is to provide basic support and information. Respond to queries concisely and accurately.
+tools:
+  - simple data retrieval
+model: llama3.2
+provider: ollama
+```
 
-                          output  = some_analysis_function(inputs, derived_data_from_inputs)
-                            Adapt accordingly based on the scope of the analysis
 
-                          """,
-        "inputs": ["script"],
-        "steps": [
-            {
-                "engine": "python",
-                "code": """{{script}}""",
-            }
-        ],
-    }
-)
+## Creating Tools
+Tools are defined as YAMLs with `.tool` extension within the npc_team/tools directory. Each tool has a name, inputs, and consists of three distinct steps: preprocess, prompt, and postprocess. The idea here is that a tool consists of a stage where information is preprocessed and then passed to a prompt for some kind of analysis and then can be passed to another stage for postprocessing. In each of these three cases, the engine must be specified. The engine can be either "natural" for natural language processing or "python" for Python code. The code is the actual code that will be executed.
 
-# Analytics team definition
-analytics_team = [
-    {
-        "name": "analyst",
-        "primary_directive": "You analyze sales performance data, focusing on revenue trends, customer behavior metrics, and market indicators. Your expertise is in extracting actionable insights from complex datasets.",
-        "model": "gpt-4o-mini",
-        "provider": "openai",
-        "tools": [code_execution_tool],  # Only the code execution tool
-    },
-    {
-        "name": "researcher",
-        "primary_directive": "You specialize in causal analysis and experimental design. Given data insights, you determine what factors drive observed patterns and design tests to validate hypotheses.",
-        "model": "gpt-4o-mini",
-        "provider": "openai",
-        "tools": [code_execution_tool],  # Only the code execution tool
-    },
-    {
-        "name": "engineer",
-        "primary_directive": "You implement data pipelines and optimize data processing. When given analysis requirements, you create efficient workflows to automate insights generation.",
-        "model": "gpt-4o-mini",
-        "provider": "openai",
-        "tools": [code_execution_tool],  # Only the code execution tool
-    },
-]
+Here is an example of a tool file:
+```yaml
+tool_name: "screen_capture_analysis_tool"
+description: Captures the whole screen and sends the image for analysis
+inputs:
+  - "prompt"
+steps:
+  - engine: "python"
+    code: |
+      # Capture the screen
+      import pyautogui
+      import datetime
+      import os
+      from PIL import Image
+      import time
+      from npcsh.image import analyze_image_base, capture_screenshot
 
+      out = capture_screenshot(npc = npc, full = True)
 
-def create_analytics_team():
-    # Initialize NPCs with just the code execution tool
-    npcs = []
-    for npc_data in analytics_team:
-        npc = NPC(
-            name=npc_data["name"],
-            primary_directive=npc_data["primary_directive"],
-            model=npc_data["model"],
-            provider=npc_data["provider"],
-            tools=[code_execution_tool],  # Only code execution tool
-        )
-        npcs.append(npc)
+      llm_response = analyze_image_base( '{{prompt}}' + "\n\nAttached is a screenshot of my screen currently. Please use this to evaluate the situation. If the user asked for you to explain what's on their screen or something similar, they are referring to the details contained within the attached image. You do not need to actually view their screen. You do not need to mention that you cannot view or interpret images directly. You only need to answer the user's request based on the attached screenshot!",
+                                        out['file_path'],
+                                        out['filename'],
+                                        npc=npc,
+                                        **out['model_kwargs'])
+      # To this:
+      if isinstance(llm_response, dict):
+          llm_response = llm_response.get('response', 'No response from image analysis')
+      else:
+          llm_response = 'No response from image analysis'
 
-    # Create coordinator with just code execution tool
-    coordinator = NPC(
-        name="coordinator",
-        primary_directive="You coordinate the analytics team, ensuring each specialist contributes their expertise effectively. You synthesize insights and manage the workflow.",
-        model="gpt-4o-mini",
-        provider="openai",
-        tools=[code_execution_tool],  # Only code execution tool
-    )
+```
 
-    # Create team
-    team = NPCTeam(npcs=npcs, foreman=coordinator)
-    return team
 
+When you have created a tool, it will be surfaced as a potential option to be used when you ask a question in the base npcsh shell. The LLM will decide if it is the best tool to use based on the user's input. Alternatively, if you'd like, you can call the tools directly, without needing to let the AI decide if it's the right one to use.
 
-def main():
-    # Create and save test data
-    data_path, sales_data = create_test_data()
+  ```npcsh
+  npcsh> /screen_cap_tool <prompt>
+  ```
+  or
+  ```npcsh
+  npcsh> /sql_executor select * from conversation_history limit 1
 
-    # Initialize team
-    team = create_analytics_team()
+  ```
+  or
+  ```npcsh
+  npcsh> /calculator 5+6
+  ```
 
-    # Run analysis - updated prompt to reflect code execution approach
-    results = team.orchestrate(
-        f"""
-    Analyze the sales data at {data_path} to:
-    1. Identify key performance drivers
-    2. Determine if mobile channel growth is significant
-    3. Recommend tests to validate growth hypotheses
 
-    Here is a header for the data file at {data_path}:
-    {sales_data.head()}
+## NPC Pipelines
 
-    When working with dates, ensure that date columns are converted from raw strings. e.g. use the pd.to_datetime function.
 
 
-    When working with potentially messy data, handle null values by using nan versions of numpy functions or
-    by filtering them with a mask .
+Let's say you want to create a pipeline of steps where NPCs are used along the way. Let's initialize with a pipeline file we'll call `morning_routine.pipe`:
+```yaml
+steps:
+  - step_name: "review_email"
+    npc: "{{ ref('email_assistant') }}"
+    task: "Get me up to speed on my recent emails: {{source('emails')}}."
 
-    Use Python code execution to perform the analysis - load the data and perform statistical analysis directly.
-    """
+
+  - step_name: "market_update"
+    npc: "{{ ref('market_analyst') }}"
+    task: "Give me an update on the latest events in the market: {{source('market_events')}}."
+
+  - step_name: "summarize"
+    npc: "{{ ref('sibiji') }}"
+    model: llama3.2
+    provider: ollama
+    task: "Review the outputs from the {{review_email}} and {{market_update}} and provide me with a summary."
+
+```
+Now youll see that we reference NPCs in the pipeline file. We'll need to make sure we have each of those NPCs available.
+Here is an example for the email assistant:
+```yaml
+name: email_assistant
+primary_directive: You are an AI assistant specialized in managing and summarizing emails. You should present the information in a clear and concise manner.
+model: gpt-4o-mini
+provider: openai
+```
+Now for the marketing analyst:
+```yaml
+name: market_analyst
+primary_directive: You are an AI assistant focused on monitoring and analyzing market trends. Provide de
+model: llama3.2
+provider: ollama
+```
+and then here is our trusty friend sibiji:
+```yaml
+name: sibiji
+primary_directive: You are a foundational AI assistant. Your role is to provide basic support and information. Respond to queries concisely and accurately.
+suggested_tools_to_use:
+  - simple data retrieval
+model: claude-3-5-sonnet-latest
+provider: anthropic
+```
+Now that we have our pipeline and NPCs defined, we also need to ensure that the source data we are referencing will be there. When we use source('market_events') and source('emails') we are asking npcsh to pull those data directly from tables in our npcsh database. For simplicity we will just make these in python to insert them for this demo:
+```python
+import pandas as pd
+from sqlalchemy import create_engine
+import os
+
+# Sample market events data
+market_events_data = {
+    "datetime": [
+        "2023-10-15 09:00:00",
+        "2023-10-16 10:30:00",
+        "2023-10-17 11:45:00",
+        "2023-10-18 13:15:00",
+        "2023-10-19 14:30:00",
+    ],
+    "headline": [
+        "Stock Market Rallies Amid Positive Economic Data",
+        "Tech Giant Announces New Product Line",
+        "Federal Reserve Hints at Interest Rate Pause",
+        "Oil Prices Surge Following Supply Concerns",
+        "Retail Sector Reports Record Q3 Earnings",
+    ],
+}
+
+# Create a DataFrame
+market_events_df = pd.DataFrame(market_events_data)
+
+# Define database path relative to user's home directory
+db_path = os.path.expanduser("~/npcsh_history.db")
+
+# Create a connection to the SQLite database
+engine = create_engine(f"sqlite:///{db_path}")
+with engine.connect() as connection:
+    # Write the data to a new table 'market_events', replacing existing data
+    market_events_df.to_sql(
+        "market_events", con=connection, if_exists="replace", index=False
     )
 
-    print(results)
+print("Market events have been added to the database.")
 
-    # Cleanup
-    os.remove(data_path)
+email_data = {
+    "datetime": [
+        "2023-10-10 10:00:00",
+        "2023-10-11 11:00:00",
+        "2023-10-12 12:00:00",
+        "2023-10-13 13:00:00",
+        "2023-10-14 14:00:00",
+    ],
+    "subject": [
+        "Meeting Reminder",
+        "Project Update",
+        "Invoice Attached",
+        "Weekly Report",
+        "Holiday Notice",
+    ],
+    "sender": [
+        "alice@example.com",
+        "bob@example.com",
+        "carol@example.com",
+        "dave@example.com",
+        "eve@example.com",
+    ],
+    "recipient": [
+        "bob@example.com",
+        "carol@example.com",
+        "dave@example.com",
+        "eve@example.com",
+        "alice@example.com",
+    ],
+    "body": [
+        "Don't forget the meeting tomorrow at 10 AM.",
+        "The project is progressing well, see attached update.",
+        "Please find your invoice attached.",
+        "Here is the weekly report.",
+        "The office will be closed on holidays, have a great time!",
+    ],
+}
 
+# Create a DataFrame
+emails_df = pd.DataFrame(email_data)
 
-if __name__ == "__main__":
-    main()
+# Define database path relative to user's home directory
+db_path = os.path.expanduser("~/npcsh_history.db")
+
+# Create a connection to the SQLite database
+engine = create_engine(f"sqlite:///{db_path}")
+with engine.connect() as connection:
+    # Write the data to a new table 'emails', replacing existing data
+    emails_df.to_sql("emails", con=connection, if_exists="replace", index=False)
+
+print("Sample emails have been added to the database.")
 
 ```
 
+
+With these data now in place, we can proceed with running the pipeline. We can do this in npcsh by using the /compile command.
+
+
+
+
+```npcsh
+npcsh> /compile morning_routine.pipe
+```
+
+
+
+Alternatively we can run a pipeline like so in Python:
+
+```bash
+from npcsh.npc_compiler import PipelineRunner
+import os
+
+pipeline_runner = PipelineRunner(
+    pipeline_file="morning_routine.pipe",
+    npc_root_dir=os.path.abspath("./"),
+    db_path="~/npcsh_history.db",
+)
+pipeline_runner.execute_pipeline(inputs)
+```
+
+What if you wanted to run operations on each row and some operations on all the data at once? We can do this with the pipelines as well. Here we will build a pipeline for news article analysis.
+First we make the data for the pipeline that well use:
+```python
+import pandas as pd
+from sqlalchemy import create_engine
+import os
+
+# Sample data generation for news articles
+news_articles_data = {
+    "news_article_id": list(range(1, 21)),
+    "headline": [
+        "Economy sees unexpected growth in Q4",
+        "New tech gadget takes the world by storm",
+        "Political debate heats up over new policy",
+        "Health concerns rise amid new disease outbreak",
+        "Sports team secures victory in last minute",
+        "New economic policy introduced by government",
+        "Breakthrough in AI technology announced",
+        "Political leader delivers speech on reforms",
+        "Healthcare systems pushed to limits",
+        "Celebrated athlete breaks world record",
+        "Controversial economic measures spark debate",
+        "Innovative tech startup gains traction",
+        "Political scandal shakes administration",
+        "Healthcare workers protest for better pay",
+        "Major sports event postponed due to weather",
+        "Trade tensions impact global economy",
+        "Tech company accused of data breach",
+        "Election results lead to political upheaval",
+        "Vaccine developments offer hope amid pandemic",
+        "Sports league announces return to action",
+    ],
+    "content": ["Article content here..." for _ in range(20)],
+    "publication_date": pd.date_range(start="1/1/2023", periods=20, freq="D"),
+}
+```
+
+Then we will create the pipeline file:
+```yaml
+# news_analysis.pipe
+steps:
+  - step_name: "classify_news"
+    npc: "{{ ref('news_assistant') }}"
+    task: |
+      Classify the following news articles into one of the categories:
+      ["Politics", "Economy", "Technology", "Sports", "Health"].
+      {{ source('news_articles') }}
+
+  - step_name: "analyze_news"
+    npc: "{{ ref('news_assistant') }}"
+    batch_mode: true  # Process articles with knowledge of their tags
+    task: |
+      Based on the category assigned in {{classify_news}}, provide an in-depth
+      analysis and perspectives on the article. Consider these aspects:
+      ["Impacts", "Market Reaction", "Cultural Significance", "Predictions"].
+      {{ source('news_articles') }}
+```
+
+Then we can run the pipeline like so:
+```bash
+/compile ./npc_team/news_analysis.pipe
+```
+or in python like:
+
+```bash
+
+from npcsh.npc_compiler import PipelineRunner
+import os
+runner = PipelineRunner(
+    "./news_analysis.pipe",
+    db_path=os.path.expanduser("~/npcsh_history.db"),
+    npc_root_dir=os.path.abspath("."),
+)
+results = runner.execute_pipeline()
+```
+
+Alternatively, if youd like to use a mixture of agents in your pipeline, set one up like this:
+```yaml
+steps:
+  - step_name: "classify_news"
+    npc: "news_assistant"
+    mixa: true
+    mixa_agents:
+      - "{{ ref('news_assistant') }}"
+      - "{{ ref('journalist_npc') }}"
+      - "{{ ref('data_scientist_npc') }}"
+    mixa_voters:
+      - "{{ ref('critic_npc') }}"
+      - "{{ ref('editor_npc') }}"
+      - "{{ ref('researcher_npc') }}"
+    mixa_voter_count: 5
+    mixa_turns: 3
+    mixa_strategy: "vote"
+    task: |
+      Classify the following news articles...
+      {{ source('news_articles') }}
+```
+You'll have to make npcs for these references to work, here are versions that should work with the above:
+```yaml
+name: news_assistant
+```
+Then, we can run the mixture of agents method like:
+
+```bash
+/compile ./npc_team/news_analysis_mixa.pipe
+```
+or in python like:
+
+```bash
+
+from npcsh.npc_compiler import PipelineRunner
+import os
+
+runner = PipelineRunner(
+    "./news_analysis_mixa.pipe",
+    db_path=os.path.expanduser("~/npcsh_history.db"),
+    npc_root_dir=os.path.abspath("."),
+)
+results = runner.execute_pipeline()
+```
+
+
+
+Note, in the future we will aim to separate compilation and running so that we will have a compilation step that is more like a jinja rendering of the relevant information so that it can be more easily audited.
+
+
 ## npcsql: SQL Integration and pipelines (UNDER CONSTRUCTION)