npcsh 1.0.14__tar.gz → 1.0.17__tar.gz

{npcsh-1.0.14 → npcsh-1.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: npcsh
-Version: 1.0.14
+Version: 1.0.17
 Summary: npcsh is a command-line toolkit for using AI agents in novel ways.
 Home-page: https://github.com/NPC-Worldwide/npcsh
 Author: Christopher Agostino
@@ -16,8 +16,10 @@ Requires-Dist: litellm
 Requires-Dist: docx
 Requires-Dist: scipy
 Requires-Dist: numpy
+Requires-Dist: thefuzz
 Requires-Dist: imagehash
 Requires-Dist: requests
+Requires-Dist: chroptiks
 Requires-Dist: matplotlib
 Requires-Dist: markdown
 Requires-Dist: networkx
@@ -40,6 +42,7 @@ Requires-Dist: flask_cors
 Requires-Dist: redis
 Requires-Dist: psycopg2-binary
 Requires-Dist: flask_sse
+Requires-Dist: wikipedia
 Provides-Extra: lite
 Requires-Dist: anthropic; extra == "lite"
 Requires-Dist: openai; extra == "lite"
@@ -54,6 +57,7 @@ Requires-Dist: chromadb; extra == "local"
 Requires-Dist: diffusers; extra == "local"
 Requires-Dist: nltk; extra == "local"
 Requires-Dist: torch; extra == "local"
+Requires-Dist: darts; extra == "local"
 Provides-Extra: yap
 Requires-Dist: pyaudio; extra == "yap"
 Requires-Dist: gtts; extra == "yap"
@@ -76,6 +80,7 @@ Requires-Dist: chromadb; extra == "all"
 Requires-Dist: diffusers; extra == "all"
 Requires-Dist: nltk; extra == "all"
 Requires-Dist: torch; extra == "all"
+Requires-Dist: darts; extra == "all"
 Requires-Dist: pyaudio; extra == "all"
 Requires-Dist: gtts; extra == "all"
 Requires-Dist: playsound==1.2.2; extra == "all"
@@ -118,18 +123,25 @@ Once installed, the following CLI tools will be available: `npcsh`, `guac`, `npc
 
 
   - Get help with a task: 
-      ```
+      ```bash
       npcsh:🤖sibiji:gemini-2.5-flash>can you help me identify what process is listening on port 5337? 
       ```
       <p align="center"> 
         <img src="https://raw.githubusercontent.com/npc-worldwide/npcsh/main/test_data/port5337.png" alt="example of running npcsh to check what processes are listening on port 5337", width=600>
       </p>
-    - Edit files
+
+  - Edit files
+      ```bash
+      npcsh>please read through the markdown files in the docs folder and suggest changes based on the current implementation in the src folder
+      ```
 
   - **Ask a Generic Question**
     ```bash
     npcsh> has there ever been a better pasta shape than bucatini?
     ```
+    ```
+    Ultimately, the "best" pasta shape depends on personal preference and the dish being prepared. Bucatini shines in specific contexts, but pasta lovers often appreciate a diverse range of shapes for their unique qualities and compatibilities with various sauces and ingredients. Each shape has its place in the culinary world, and trying different types can enhance the overall dining experience.                                                          
+    ```
     
     ```
     .Loaded .env file...                                                                                                                                               
@@ -150,11 +162,11 @@ Once installed, the following CLI tools will be available: `npcsh`, `guac`, `npc
     ```
     <p align="center">
         <img src="https://raw.githubusercontent.com/npc-worldwide/npcsh/main/test_data/search_example.png" alt="example of search results", width=600>
-    </p>
+     </p>
 
   - **Computer Use**
     ```bash
-    /plonk -n 'npc_name' -sp 'task for plonk to carry out'
+    /plonk 'find out the latest news on cnn'
     ```
 
   - **Generate Image**
@@ -168,15 +180,16 @@ Once installed, the following CLI tools will be available: `npcsh`, `guac`, `npc
     ```bash
     /roll 'generate a video of a hat riding a dog'
     ```
+    <!--
       <p align="center">
         <img src="https://raw.githubusercontent.com/npc-worldwide/npcsh/main/test_data/hat_video.mp4" alt="video of a hat riding a dog", width=250>
-      </p>
+      </p> -->
 
   - **Serve an NPC Team**
     ```bash
     /serve --port 5337 --cors='http://localhost:5137/'
     ```
-  - **Screenshot Analysis**
+  - **Screenshot Analysis**: select an area on your screen and then send your question to the LLM
     ```bash
     /ots
     ```
@@ -184,19 +197,21 @@ Once installed, the following CLI tools will be available: `npcsh`, `guac`, `npc
 
 # Macros
 -  activated by invoking `/<command> ...` in `npcsh`, macros can be called in bash or through the `npc` CLI. In our examples, we provide both `npcsh` calls as well as bash calls with the `npc` cli where relevant. For converting any `/<command>` in `npcsh` to a bash version, replace the `/` with `npc ` and the macro command will be invoked as a positional argument. Some, like breathe, flush,
-
-    - ## TL; DR:
+    
     - `/alicanto` - Conduct deep research with multiple perspectives, identifying gold insights and cliff warnings
     - `/brainblast` - Execute an advanced chunked search on command history
     - `/breathe` - Condense context on a regular cadence
     - `/compile` - Compile NPC profiles
+    - `/corca` - Enter the Corca MCP-powered agentic shell. Usage: /corca [--mcp-server-path path]                  
     - `/flush` - Flush the last N messages
     - `/guac` - Enter guac mode
     - `/help` - Show help for commands, NPCs, or Jinxs. Usage: /help 
     - `/init` - Initialize NPC project
     - `/jinxs` - Show available jinxs for the current NPC/Team
+    - `/npc-studio` - Start npc studio                                                                                                                           
     - `/ots` - Take screenshot and analyze with vision model
-    - `/plan` - Execute a plan command\n\n/plonk - Use vision model to interact with GUI. Usage: /plonk <task description>
+    - `/plan` - Execute a plan command
+    - `/plonk` - Use vision model to interact with GUI. Usage: /plonk <task description>
     - `/pti` - Use pardon-the-interruption mode to interact with reasoning model LLM
     - `/rag` - Execute a RAG command using ChromaDB embeddings with optional file input (-f/--file)
     - `/roll` - generate a video with video generation model
@@ -211,13 +226,13 @@ Once installed, the following CLI tools will be available: `npcsh`, `guac`, `npc
     - `/wander` - A method for LLMs to think on a problem by switching between states of high temperature and low temperature
     - `/yap` - Enter voice chat (yap) mode
     
-    ## Common Command-Line Flags\n\nThe shortest unambiguous prefix works (e.g., `-t` for `--temperature`).
+    ## Common Command-Line Flags:
     
     ```
     Flag              Shorthand    | Flag              Shorthand    | Flag              Shorthand    | Flag              Shorthand   
     ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------
     --attachments     (-a)         | --height          (-h)         | --num_npcs        (-num_n)     | --team            (-tea)      
-    --config_dir      (-con)       | --igmodel         (-igm)       | --output_file     (-o)         | --temperature     (-tem)      
+    --config_dir      (-con)       | --igmodel         (-igm)       | --output_file     (-o)         | --temperature     (-t)      
     --cors            (-cor)       | --igprovider      (-igp)       | --plots_dir       (-pl)        | --top_k                       
     --creativity      (-cr)        | --lang            (-l)         | --port            (-po)        | --top_p                       
     --depth           (-d)         | --max_tokens      (-ma)        | --provider        (-pr)        | --vmodel          (-vm)       
@@ -228,368 +243,19 @@ Once installed, the following CLI tools will be available: `npcsh`, `guac`, `npc
     ```
     '
 
-    - ## alicanto: a research exploration agent flow. 
-
-      <p align="center"><a href ="https://github.com/npc-worldwide/npcsh/blob/main/docs/alicanto.md"> 
-        <img src="https://raw.githubusercontent.com/npc-worldwide/npcsh/main/npcsh/npc_team/alicanto.png" alt="logo for deep research", width=250></a>
-      </p>
-
-    - Examples:
-      ```bash
-      # npcsh
-      /alicanto "What are the implications of quantum computing for cybersecurity?"
-      /alicanto "How might climate change impact global food security?" --num-npcs 8 --depth 5
-      ```
-
-      ```bash
-      # bash
-      npc alicanto "What ethical considerations should guide AI development?" --max_facts_per_chain 0.5 --max_thematic_groups 3 --max_criticisms_per_group 3 max_conceptual_combinations 3 max_experiments 10 
-
-      npc alicanto "What is the future of remote work?" --format report
-      ```
-    - ## Brainblast: searching through past messages:
-        ```bash
-        # npcsh
-        /brainblast 'subtle summer winds'  --top_k 10
-        ```
-        ```bash
-        # bash
-        npc brainblast 'python dictionaries'                                        
-        ```
-    - ## Breathe: Condense conversation context (shell only):
-        ```bash
-        # npcsh
-        /breathe
-        /breathe -p ollama -m qwen3:latest 
-        ```
-    - ## Compile: render npcs for use without re-loading npcsh
-      ```bash
-      # npcsh
-      /compile /path/to/npc
-      ```
-    - ## flush: flush context  (shell only):
-      ```bash
-      /flush
-      ```
-
-
-    - ## `guac`
-
-    <p align="center"><a href ="https://github.com/npc-worldwide/npcsh/blob/main/docs/guac.md"> 
-      <img src="https://raw.githubusercontent.com/npc-worldwide/npcsh/main/npcsh/npc_team/guac.png" alt="npcsh logo of a solarpunk sign", width=250></a>
-    </p> 
-
-    - a replacement shell for interpreters like python/r/node/julia with an avocado input marker 🥑 that brings a pomodoro-like approach to interactive coding. 
-        - Simulation:      
-            `🥑 Make a markov chain simulation of a random walk in 2D space with 1000 steps and visualize`
-            ```
-            # Generated python code:
-            import numpy as np
-            import matplotlib.pyplot as plt
-
-            # Number of steps
-            n_steps = 1000
-
-            # Possible moves: up, down, left, right
-            moves = np.array([[0, 1], [0, -1], [1, 0], [-1, 0]])
-
-            # Initialize position array
-            positions = np.zeros((n_steps+1, 2), dtype=int)
-
-            # Generate random moves
-            for i in range(1, n_steps+1):
-                step = moves[np.random.choice(4)]
-                positions[i] = positions[i-1] + step
-
-            # Plot the random walk
-            plt.figure(figsize=(8, 8))
-            plt.plot(positions[:, 0], positions[:, 1], lw=1)
-            plt.scatter([positions[0, 0]], [positions[0, 1]], color='green', label='Start')
-            plt.scatter([positions[-1, 0]], [positions[-1, 1]], color='red', label='End')
-            plt.title('2D Random Walk - 1000 Steps (Markov Chain)')
-            plt.xlabel('X Position')
-            plt.ylabel('Y Position')
-            plt.legend()
-            plt.grid(True)
-            plt.axis('equal')
-            plt.show()
-            # Generated code executed successfully
-          
-            ```
-            <p align="center">
-              <img src="https://raw.githubusercontent.com/npc-worldwide/npcsh/main/test_data/markov_chain.png" alt="markov_chain_figure", width=250>
-            </p>
-            
-            Access the variables created in the code:    
-            `🥑 print(positions)`
-            ```
-            [[  0   0]
-            [  0  -1]
-            [ -1  -1]
-            ...
-            [ 29 -23]
-            [ 28 -23]
-            [ 27 -23]]
-            ```
-        
-        - Run a python script:   
-            `🥑 run file.py`    
-        - Refresh:    
-            `🥑 /refresh`       
-        - Show current variables:    
-            `🥑 /show`    
-
-        A guac session progresses through a series of stages, each of equal length. Each stage adjusts the emoji input prompt. Once the stages have passed, it is time to refresh. Stage 1: `🥑`, Stage 2: `🥑🔪` Stage 3: `🥑🥣` Stage:4 `🥑🥣🧂`, `Stage 5: 🥘 TIME TO REFRESH`. At stage 5, the user is reminded to refresh with the /refresh macro. This will evaluate the session so farand suggest and implement new functions or automations that will aid in future sessions, with the ultimate approval of the user.
-
-
-    - ## help:/ Show help for commands, NPCs, or Jinxs. 
-       ```bash
-       /help 
-       ```
-    - ## init - Initialize NPC project        
-    - ## jinxs : show available jinxs                                                                                                                     
-    - ## ots: Over-the-shoulder screen shot analysis
-        - Screenshot analysis:     
-        ```bash
-        #npcsh
-        /ots
-        /ots output_filename =...
-        ```
-        ```bash
-        #bash
-        npc ots ...
-        ```
-    - ## `plan`: set up cron jobs:
-        ```bash
-        # npcsh
-        /plan 'a description of a cron job to implement' -m gemma3:27b -p ollama 
-        ```
-        ```bash
-        # bash
-        npc plan
-        ```
-
-    - ## `plonk`: Computer use:     
-        ```bash
-        # npcsh
-        /plonk -n 'npc_name' -sp 'task for plonk to carry out '
-
-        #bash
-        npc plonk
-        ```
-    - ## `pti`: a reasoning REPL loop with interruptions
-      
-        ```npcsh
-        /pti  -n frederic -m qwen3:latest -p ollama 
-        ```
-
-        Or from the bash cmd line:
-        ```bash
-        pti
-        ```
-      <p align="center"><a href ="https://github.com/npc-worldwide/npcsh/blob/main/docs/pti.md"> 
-        <img src="https://raw.githubusercontent.com/npc-worldwide/npcsh/main/npcsh/npc_team/frederic4.png" alt="npcsh logo of frederic the bear and the pti logo", width=250></a>
-      </p>
-
-    - ## `rag`: embedding search through chroma db, optional file input
-    - ## `roll`: your video generation assistant
-      - 
-        ```npcsh
-        /roll --provider ollama --model llama3
-        ```
-
-    - ## sample: one-shot sampling from LLMs with specific parameters
-        ```bash
-        # npcsh
-        /sample 'prompt'
-        /sample -m gemini-1.5-flash "Summarize the plot of 'The Matrix' in three sentences."
-
-        /sample --model claude-3-5-haiku-latest "Translate 'good morning' to Japanese."
-
-        /sample model=qwen3:latest "tell me about the last time you went shopping."
-
-
-        ```
-        ```bash
-        # bash
-        npc sample -p ollama -m gemma3:12b --temp 1.8 --top_k 50 "Write a haiku about the command line."
-
-        npc sample model=gpt-4o-mini "What are the primary colors?" --provider openai
-        ```
-
-    - ## search: use an internet search provider     
-        ```npcsh
-        /search -sp perplexity 'cal bears football schedule'
-        /search --sprovider duckduckgo 'beef tongue'        
-        # Other search providers could be added, but we have only integrated duckduckgo and perplexity for the moment.
-        ```
-
-        ```bash
-        npc search 'when is the moon gonna go away from the earth'
-        ```
-    
-
-    - ## serve: serve an npc team     
-        ```bash
-        /serve 
-        /serve ....    
-        # Other search providers could be added, but we have only integrated duckduckgo and perplexity for the moment.
-        ```
-
-        ```bash
-        npc serve
-        ```
-
-    - ## set: change current model, env params
-        ```bash
-        /set model ... 
-        /set provider ...
-        /set NPCSH_API_URL https://localhost:1937
-        ```
-
-        ```bash
-        npc set ...
-        ```
-    - ## sleep: prune and evolve the current knowledge graph 
-        ```bash
-        /sleep
-        /sleep --dream
-        /sleep --ops link_facts,deepen
-        ```
-
-        ```bash
-        npc sleep
-        ```
-    - ## `spool`
-    <p align="center"><a href ="https://github.com/npc-worldwide/npcsh/blob/main/docs/spool.md"> 
-      <img src="https://raw.githubusercontent.com/npc-worldwide/npcsh/main/npcsh/npc_team/spool.png" alt="logo for spool", width=250></a>
-    </p>
-
-    - Enter chat loop with isolated context, attachments, specified models/providers:     
-        ```npcsh
-        /spool -n <npc_name>
-        /spool --attachments ./test_data/port5337.png,./test_data/yuan2004.pdf,./test_data/books.csv
-        /spool --provider ollama --model llama3
-        /spool -p deepseek -m deepseek-reasoner
-        /spool -n alicanto
-        ```
-
-
-
-    - ## Trigger: schedule listeners, daemons
-        ```bash
-        /trigger 'a description of a trigger to implement with system daemons/file system listeners.' -m gemma3:27b -p ollama
-        ```
-        ```bash
-        npc trigger
-        ``` 
-
-
-
-
-    
-
-    - ## Vixynt: Image generation and editing:   
-        ```bash
-        npcsh
-        /vixynt 'an image of a dog eating a hat'
-        /vixynt --output_file ~/Desktop/dragon.png "A terrifying dragon"
-        /vixynt "A photorealistic portrait of a cat wearing a wizard hat in the dungeon of the master and margarita" -w 1024.   height=1024        
-        /vixynt -igp ollama  --igmodel Qwen/QwenImage --output_file /tmp/sub.png width=1024 height=512 "A detailed steampunk submarine exploring a vibrant coral reef, wide aspect ratio"
-        ```
-
-        ```bash
-        # bash
-        npc vixynt --attachments ./test_data/rabbit.PNG "Turn this rabbit into a fierce warrior in a snowy winter scene" -igp openai -igm gpt-image
-        npc vixynt --igmodel CompVis/stable-diffusion-v1-4 --igprovider diffusers "sticker of a red tree"
-        ```
-
-
-
-
-
-    - ## `wander`: daydreaming for LLMs
-
-      <p align="center"><a href ="https://github.com/npc-worldwide/npcsh/blob/main/docs/wander.md">
-        <img src="https://raw.githubusercontent.com/npc-worldwide/npcsh/main/npcsh/npc_team/kadiefa.png" alt="logo for wander", width=250></a>
-      </p>
-      A system for thinking outside of the box. From our testing, it appears gpt-4o-mini and gpt-series models in general appear to wander the most through various languages and ideas with high temperatures. Gemini models and many llama ones appear more stable despite high temps. Thinking models in general appear to be worse at this task.
-
-      - Wander with an auto-generated environment  
-        ```
-        npc --model "gemini-2.0-flash"  --provider "gemini"  wander "how does the bar of a galaxy influence the the surrounding IGM?" \
-          n-high-temp-streams=10 \
-          high-temp=1.95 \
-          low-temp=0.4 \
-          sample-rate=0.5 \
-          interruption-likelihood=1
-        ```
-      - Specify a custom environment
-        ```
-        npc --model "gpt-4o-mini"  --provider "openai"  wander "how does the goos-hanchen effect impact neutron scattering?" \
-          environment='a ships library in the south.' \
-          num-events=3 \
-          n-high-temp-streams=10 \
-          high-temp=1.95 \
-          low-temp=0.4 \
-          sample-rate=0.5 \
-          interruption-likelihood=1
-        ```
-      - Control event generation
-        ```
-        npc wander "what is the goos hanchen effect and does it affect water refraction?" \
-        --provider "ollama" \
-        --model "deepseek-r1:32b" \
-        environment="a vast, dark ocean ." \
-        interruption-likelihood=.1
-        ```
-
-    - ## `yap`: an agentic voice control loop
-
-
-    <p align="center"><a href ="https://github.com/npc-worldwide/npcsh/blob/main/docs/yap.md"> 
-      <img src="https://raw.githubusercontent.com/npc-worldwide/npcsh/main/npcsh/npc_team/yap.png" alt="logo for yap ", width=250></a>
-    </p>
-
-    - an agentic voice control loop with a specified agent. When launching `yap`, the user enters the typical `npcsh` agentic loop except that the system is waiting for either text or audio input.
-    - voice chat:     
-        ```bash
-        # npcsh
-        /yap
-        ```
-        ```bash
-        # bash
-        yap
-        npc yap
-        ```
-    - Show available Jinja Execution Templates:
-        ```bash
-        # npcsh
-        /jinxs
-        ```
-        ```bash
-        # bash
-        npc jinxs 
-        ```
-
-
-
-## Inference Capabilities
-- `npcsh` works with local and enterprise LLM providers through its LiteLLM integration, allowing users to run inference from Ollama, LMStudio, OpenAI, Anthropic, Gemini, and Deepseek, making it a versatile tool for both simple commands and sophisticated AI-driven tasks. 
-
 ## Read the Docs
+To see more about how to use the macros and modes in the NPC Shell, read the docs at [npc-shell.readthedocs.io](https://npc-shell.readthedocs.io/en/latest/)
 
-Read the docs at [npcsh.readthedocs.io](https://npcsh.readthedocs.io/en/latest/)
 
+## Inference Capabilities
+- `npcsh` works with local and enterprise LLM providers through its LiteLLM integration, allowing users to run inference from Ollama, LMStudio, vLLM, MLX, OpenAI, Anthropic, Gemini, and Deepseek, making it a versatile tool for both simple commands and sophisticated AI-driven tasks. 
 
 ## NPC Studio
 There is a graphical user interface that makes use of the NPC Toolkit through the NPC Studio. See the open source code for NPC Studio [here](https://github.com/npc-worldwide/npc-studio). Download the executables at [our website](https://enpisi.com/npc-studio).
 
-
 ## Mailing List
 Interested to stay in the loop and to hear the latest and greatest about `npcpy`, `npcsh`, and NPC Studio? Be sure to sign up for the [newsletter](https://forms.gle/n1NzQmwjsV4xv1B2A)!
 
-
 ## Support
 If you appreciate the work here, [consider supporting NPC Worldwide with a monthly donation](https://buymeacoffee.com/npcworldwide), [buying NPC-WW themed merch](https://enpisi.com/shop), or hiring us to help you explore how to use the NPC Toolkit and AI tools to help your business or research team, please reach out to info@npcworldwi.de .
 
@@ -706,7 +372,7 @@ python-tkinter (pyautogui)
 </details>
 
 ## Startup Configuration and Project Structure
-After `npcsh` has been pip installed, `npcsh`, `guac`, `pti`, `spool`, `yap` and the `npc` CLI can be used as command line tools. To initialize these correctly, first start by starting the NPC shell:
+After `npcsh` has been pip installed, `npcsh`, `corca`, `guac`, `pti`, `spool`, `yap` and the `npc` CLI can be used as command line tools. To initialize these correctly, first start by starting the NPC shell:
 ```bash
 npcsh
 ```
@@ -751,6 +417,10 @@ export PERPLEXITY_API_KEY='your_perplexity_key'
 ├── npc_team/           # Global NPCs
 │   ├── jinxs/          # Global tools
 │   └── assembly_lines/ # Workflow pipelines
+│   └── example.npc  # globally available npc 
+│   └── global.ctx  # global context file
+
+
 
 ```
 For cases where you wish to set up a project specific set of NPCs, jinxs, and assembly lines, add a `npc_team` directory to your project and `npcsh` should be able to pick up on its presence, like so:
@@ -758,8 +428,8 @@ For cases where you wish to set up a project specific set of NPCs, jinxs, and as
 ./npc_team/            # Project-specific NPCs
 ├── jinxs/             # Project jinxs #example jinx next
 │   └── example.jinx
-└── assembly_lines/    # Project workflows
-    └── example.pipe
+└── assembly_lines/    # Agentic Workflows
+    └── example.line
 └── models/    # Project workflows
     └── example.model
 └── example1.npc        # Example NPC