diff --git a/README.md b/README.md index 613a87f..f01e996 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ start ./start_services.cmd # Window Run the assistant: ```sh -python3 main.py +python3 cli.py ``` *See the **Usage** section if you don't understand how to use it* @@ -144,7 +144,7 @@ Make sure the services are up and running with `./start_services.sh` and run the ```sh sudo ./start_services.sh -python3 main.py +python3 cli.py ``` You will be prompted with `>>> ` @@ -259,7 +259,7 @@ Run the assistant: ```sh sudo ./start_services.sh # start_services.cmd on windows -python3 main.py +python3 cli.py ``` ## **Run with an API** @@ -284,7 +284,7 @@ Run the assistant: ```sh sudo ./start_services.sh # start_services.cmd on windows -python3 main.py +python3 cli.py ``` --- @@ -338,20 +338,35 @@ stealth_mode = False **Explanation**: - is_local -> Runs the agent locally (True) or on a remote server (False). + - provider_name -> The provider to use (one of: `ollama`, `server`, `lm-studio`, `deepseek-api`) + - provider_model -> The model used, e.g., deepseek-r1:32b. + - provider_server_address -> Server address, e.g., 127.0.0.1:11434 for local. Set to anything for non-local API. + - agent_name -> Name of the agent, e.g., Friday. Used as a trigger word for TTS. + - recover_last_session -> Restarts from last session (True) or not (False). + - save_session -> Saves session data (True) or not (False). + - speak -> Enables voice output (True) or not (False). + - listen -> listen to voice input (True) or not (False). + - work_dir -> Folder the AI will have access to. eg: /Users/user/Documents/. + - jarvis_personality -> Uses a JARVIS-like personality (True) or not (False). This simply change the prompt file. + - languages -> The list of supported language, needed for the llm router to work properly, avoid putting too many or too similar languages. + - headless_browser -> Runs browser without a visible window (True) or not (False). + - stealth_mode -> Make bot detector time harder. Only downside is you have to manually install the anticaptcha extension. +- languages -> List of supported languages. Required for agent routing system. The longer the languages list the more model will be downloaded. + ## Providers The table below show the available providers: @@ -421,7 +436,7 @@ If this section is incomplete please raise an issue. Deepseek R1 excels at reasoning and tool use for its size. We think it’s a solid fit for our needs other models work fine, but Deepseek is our primary pick. -**Q: I get an error running `main.py`. What do I do?** +**Q: I get an error running `cli.py`. What do I do?** Ensure Ollama is running (`ollama serve`), your `config.ini` matches your provider, and dependencies are installed. If none work feel free to raise an issue. diff --git a/README_CHS.md b/README_CHS.md index 7601542..900bd2c 100644 --- a/README_CHS.md +++ b/README_CHS.md @@ -127,7 +127,7 @@ start ./start_services.cmd # Window 运行 AgenticSeek: ```sh -python3 main.py +python3 cli.py ``` *如果你不知道如何开始,请参阅 **Usage** 部分* @@ -143,11 +143,11 @@ python3 main.py ## Usage (使用方法) -确定所有的核心档案都启用了,也就是执行过这条命令 `./start_services.sh` 然后你就可以使用 `python3 main.py` 来启动 AgenticSeek 了! +确定所有的核心档案都启用了,也就是执行过这条命令 `./start_services.sh` 然后你就可以使用 `python3 cli.py` 来启动 AgenticSeek 了! ```sh sudo ./start_services.sh -python3 main.py +python3 cli.py ``` 当你看到执行后显示 `>>> ` @@ -264,7 +264,7 @@ provider_server_address = x.x.x.x:3333 ```sh sudo ./start_services.sh -python3 main.py +python3 cli.py ``` ## **Run with an API (透过 API 执行)** @@ -289,7 +289,7 @@ provider_server_address = 127.0.0.1:5000 ```sh sudo ./start_services.sh -python3 main.py +python3 cli.py ``` --- @@ -379,6 +379,8 @@ stealth_mode = False - False:背景執行瀏覽器。 - stealth_mode - 隱私模式,但需要你自己安裝反爬蟲擴充功能。 +- languages + - 支持的语言列表。用于代理路由系统。语言列表越长,下载的模型越多。 ## 框架 diff --git a/README_CHT.md b/README_CHT.md index 59d04b4..98bdb3b 100644 --- a/README_CHT.md +++ b/README_CHT.md @@ -127,7 +127,7 @@ start ./start_services.cmd # Window 運行 AgenticSeek: ```sh -python3 main.py +python3 cli.py ``` *如果你不知道如何開始,請參閱 **Usage** 部分* @@ -143,11 +143,11 @@ python3 main.py ## Usage (使用方法) -確定所有的核心檔案都啟用了,也就是執行過這條命令 `./start_services.sh` 然後你就可以使用 `python3 main.py` 來啟動 AgenticSeek 了! +確定所有的核心檔案都啟用了,也就是執行過這條命令 `./start_services.sh` 然後你就可以使用 `python3 cli.py` 來啟動 AgenticSeek 了! ```sh sudo ./start_services.sh -python3 main.py +python3 cli.py ``` 當你看到執行後顯示 `>>> ` @@ -264,7 +264,7 @@ provider_server_address = x.x.x.x:3333 ```sh sudo ./start_services.sh -python3 main.py +python3 cli.py ``` ## **Run with an API (透過 API 執行)** @@ -289,7 +289,7 @@ provider_server_address = 127.0.0.1:5000 ```sh sudo ./start_services.sh -python3 main.py +python3 cli.py ``` --- @@ -379,6 +379,8 @@ stealth_mode = False - False:背景執行瀏覽器。 - stealth_mode - 隱私模式,但需要你自己安裝反爬蟲擴充功能。 +- languages + - 支持的语言列表。用于代理路由系统。语言列表越长,下载的模型越多。 ## 框架 diff --git a/README_FR.md b/README_FR.md index 250dcc0..2f703dd 100644 --- a/README_FR.md +++ b/README_FR.md @@ -121,7 +121,7 @@ sudo ./start_services.sh Lancer agenticSeek: ```sh -python3 main.py +python3 cli.py ``` Voyez la section **Utilisation** si vous ne comprenez pas comment l’utiliser @@ -136,11 +136,11 @@ Voyez la section **Configuration** pour une explication détaillée du fichier d ## Utilisation -Assurez-vous que les services sont en cours d’exécution avec ./start_services.sh et lancez AgenticSeek avec python3 main.py +Assurez-vous que les services sont en cours d’exécution avec ./start_services.sh et lancez AgenticSeek avec python3 cli.py ```sh sudo ./start_services.sh -python3 main.py +python3 cli.py ``` Vous verrez un prompt: ">>> " @@ -255,7 +255,7 @@ Exécutez l’assistant : ```sh sudo ./start_services.sh -python3 main.py +python3 cli.py ``` ## **Exécuter avec une API** @@ -278,7 +278,7 @@ Exécutez l’assistant : ```sh sudo ./start_services.sh -python3 main.py +python3 cli.py ``` ## Config @@ -297,6 +297,7 @@ speak = False listen = False work_dir = /Users/mlg/Documents/ai_folder jarvis_personality = False +languages = en fr [BROWSER] headless_browser = False stealth_mode = False @@ -330,6 +331,7 @@ stealth_mode = False `stealth_mode` -> Rend la détection des bots plus difficile. Le seul inconvénient est que vous devez installer manuellement l’extension anticaptcha. +`languages` -> La liste de languages supportés (nécessaire pour le routage d'agents). Plus la liste est longue. Plus un nombre important de modèles sera téléchargés. ## Providers