Skip to content

Latest commit

 

History

History
309 lines (161 loc) · 14.4 KB

README.md

File metadata and controls

309 lines (161 loc) · 14.4 KB

ToolMate AI

ToolMate AI, formerly known as LetMeDoIt AI, is a cutting-edge AI companion that seamlessly integrates agents, tools, and plugins to excel in conversations, generative work, and task execution. With the ability to perform multi-step actions, users can customize workflows to tackle complex projects with ease.

Audio Overview

Watch the video

Click to listen audio overview

Three Inteface Options

  1. Graphical User Interface

toolmateai

toolmateai

ToolSelectionWindow

  1. Terminal Interactive Mode, run:

toolmate

ToolMateAI

  1. Command Line Interface, for options, run:

tm -h

cli_tm

Simple to Use

With tool auto-selection agent enabled, simply enter your request, e.g.

Send a thank you email to Peter at [email protected]

You can also specify a tool manually, e.g.

@send_gmail Send a thank you email to Peter at [email protected]

Remark: Default tool @chat is applied to chat with users when tool-selection agent is not enabled and a tool is not specified.

To run prompt directly via terminal, simply prefix your requests with tm or tmc, e.g.

tm Send a thank you email to Peter at [email protected]

Remarks: tm always starts a new conversation, whereas tmc extends a conversation in a chat session. You can always return and continue the previous conversation by using the tmc command, even if you have run other commands after the initial conversation or closed the terminal window and opened a new one, as long as you do not restart the backend tmserver or your device system.

To run multiple tools in a single request, simply declare tools, with each tool signature, which starts with @, followed by an instruction, e.g.

@chat Tell me a joke
@chat Tell me anther one
@send_gmail Send these joke to Peter at [email protected]

Pre-defined workflow is supported, e.g.:

Save the following content in a file and named, for example, my_workflow.txt:

@search_google Updates about ToolMate AI?
@send_gmail Email this information to Peter at [email protected]

In GUI or Terminal modes, run:

@workflow my_workflow.txt

In CLI mode, run:

cat my_workflow.txt | tm

Read more about tools at:

https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/Tool%20Selection%20Configurations.md

https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/Tool%20Descriptions.md

https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/Running%20Multiple%20Tools%20in%20One%20Go.md

Background

https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/LetMeDoIt%20Mode.md

Documentation

https://github.com/eliranwong/toolmate/wiki

Latest changes

https://github.com/eliranwong/toolmate/blob/main/latest_changes.md

Supported Platforms

Windows, macOS, Linux, ChromeOS, Android

AI Backends and Models

backends

ToolMate AI supports a wide range of AI backends and models, including Ollama, Llama.cpp, Llama-cpp-python, Anthropic API, Groq Cloud API, Mistral AI API, X AI API, OpenAI API, Github API, Azure API, Google AI Studio API, Google Vertex AI and Google GenAI SDK. Llama-cpp-python is selected as the default backend because it is completely free and requires no additional setup. However, users can switch backends at any time.

Read more at https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/Supported%20Backends%20and%20Models.md

New Additions

NEW! Support Anthropic Claude 3.5 Sonnet

NEW! Support Gemini 2.0 Models

NEW! Support Paid Azure API Keys

NEW! Support Free Github API Keys

NEW! Graphical User Interface

NEW! AutoGen Agents Integration

NEW! Support Ollama v0.5.0+ latest structured output feature

NEW! Support Llama.cpp server running on Android

NEW! Support X AI / Grok API Keys

NEW! ToolMate API Server & Client

NEW! Support Mistral API Keys

NEW! Edit Current Conversation

NEW! Support Android

NEW! Perplexica and SearXNG Integration

Distinctive Features

Tool Selection Agent

Deep Reflection Agents

Risk Management Agent

Running Multiple Tools in One Go

Plentiful Built-in Tools

Highly Customisable Plugins

Savable, Searchable and Sharable Records

Integration with Popular AI Tools

Quick Tool Calling

Starting with version 0.2.86+, users can utilize the @ symbol to designate a specific tool within the application. The toolmate package now comes with a suite of pre-built tools:

@add_google_calendar_event @add_outlook_calendar_event @agents @anthropic @append_command @append_fabric @append_fabric_pattern @append_instruction @apps @azure @b @bapi @bible @bible_commentary @captain @chat @codey @command @convert_relative_datetime @copy_to_clipboard @correct_python_code @create_image_dalle3 @create_image_imagen3 @create_map @create_qrcode @create_statistical_graphics @datetimes @deep_reflection @download_web_content @download_youtube_audio @download_youtube_video @edit_text @examine_audio_google @examine_audio_groq @examine_audio_openai @examine_audio_whisper @examine_files @examine_images_azure @examine_images_github @examine_images_googleai @examine_images_groq @examine_images_ollama @examine_images_openai @examine_images_pixtral @examine_images_vertexai @examine_web_content @execute_python_code @extract_bible_references @extract_python_code @extract_text @fabric @fabric_pattern @files @genai @general @github @googleai @groq @group @help @images @improve_writing @install_python_package @it @list_current_directory_contents @llamacpppython @llamacppserver @load_conversations @lyrics @map @mistral @modify_images @music @news @o1 @o1_mini @ollama @online @open_browser @openai @packages @palm2 @paste_from_clipboard @perplexica_github @perplexica_googleai @perplexica_groq @perplexica_openai @perplexica_xai @proxy @qna @radio @read_aloud @recommend_tool @reflection @remove_image_background @repos @save_memory @science @scientific_publications @screenshot @search_bible @search_bible_paragraphs @search_bing @search_conversations @search_finance @search_google @search_google_news @search_memory @search_searxng @search_sqlite @search_tavily @search_weather @send_gmail @send_outlook @send_tweet @social_media @software_wikis @task @tavily @transcribe_audio_google @transcribe_audio_groq @transcribe_audio_openai @transcribe_audio_whisper @translate @uniquebible @uniquebible_api @uniquebible_web @use_my_computer @vertexai @videos @web @wikimedia @workflow @xai

Android-only tools:

@show_location @show_connection @start_recording @stop_recording @phone_call @play_media @search_contacts @take_photo @selfie @read_sms @send_sms @send_email @send_whatsapp @share @share_file

For those interested in expanding the capabilities of ToolMate AI, custom tools can be added to the system via plugins.

Tips:

  • Type the @ symbol to launch a drop-down menu listing all available tools for selection..
  • Enter the @ symbol to display a list of all available tools and their descriptions
  • @chat is regarded as a single tool. If you just want a direct response generated by LLM, simply use @chat.
  • @command @task is like a magic tools designed to execute computing tasks upon user requests.
  • @recommend_tool is designed to help users to find an appropriate tool to resolve a given request.
  • @help is created for searching documentations

Selectie Screenshots

Desktop GUI Integration

work_with_clipboard

Android Support

android

Tool Selection Agent

tool_selection_agent_compressed

Read more ...

Multiple Tools in One Go

From version 0.2.87+, ToolMate AI supports use of multiple tools in a single request. It enables individual tools to work on results, generated by running previous tools.

multiple_tools_in_single_prompt

Read more at: https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/Running%20Multiple%20Tools%20in%20One%20Go.md

Customizable Plugins

plugins

AutoGen Agents Integration

https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/AutoGen%20Integration.md

System Command and Fabric Integration

CLI Options: https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/CLI%20Options.md

System Command Integration: https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/System%20Command%20Integration.md

Fabric Integration: https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/Fabric%20Integration.md

Support GPU Offloading

llamacpp_with_gpu_offloading_compressed

Access to Real-time Data

realtime_information

Access to Device Information

access_device_information

Task Execution

task_execution

Content Creation

content_creation

Installation

For Windows / macOS / LinuX / ChromeOS users:

pip install --upgrade toolmate

or

pip install --upgrade toolmate_lite

The lite version toolmate_lite runs faster and supports Android Termux. It lacks some of the features that are equipped with the full version toolmate.

For Android users:

pip install --upgrade toolmate_lite

Extra Modules

cpp install additional cpp libraries, i.e. llama-cpp-python[server] and stable-diffusion-cpp-python

pip install --upgrade toolmate[cpp]

gui install additional GUI library for running gui system tray and experimental desktop assistant

pip install --upgrade toolmate[gui]

linux install additional packages for Linux users, i.e. flaml[automl], piper-tts

pip install --upgrade toolmate[linux]

bible install additional libraries for working with bible tools

pip install --upgrade toolmate[bible]

Read more at https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/Install%20ToolMate.md

Setup

tmsetup

Interactive Mode

toolmate

CLI

tm -h

GPU Acceleration

GPU Acceleration

GPU Acceleration with Llama.cpp Server

Quick Guide

https://github.com/eliranwong/toolmate/blob/main/package/toolmate/docs/Quick%20Guide.md

More

Documentation https://github.com/eliranwong/toolmate/wiki

Welcome Contributions

You are welcome to make contributions to this project by:

  • joining the development collaboratively

  • donations to show support and invest for the future

Support link: https://www.paypal.me/toolmate

Please kindly report of any issues at https://github.com/eliranwong/toolmate/issues