diff --git a/README.md b/README.md index 65f7bf4..02edb3f 100644 --- a/README.md +++ b/README.md @@ -318,6 +318,164 @@ For creating your own tiger you should install a Upsonic On-Prem docker containe upsonic.autogen(chatbot, userproxy) ``` +## ❓ Frequently Asked Questions (FAQ) + +### What is Tiger? + +Tiger is a community-driven project developing a reusable and integrated tool ecosystem for LLM Agent Revolution. It provides an AI-oriented computer interface with threads connected to the LLM interface — essentially **Neuralink for AI Agents**. Your LLM agents can write and execute code, use search engines, manage calendars, control mouse and keyboard, speak into headphones, and much more. + +### How is Tiger different from other agent tools? + +Tiger focuses on: +- **Community-driven tools** — maintained and curated by the community +- **Framework-agnostic** — works with crewAI, LangChain, AutoGen, and any framework using function calls +- **No API keys required** — tools work like normal human events (mouse, keyboard, browser) +- **Public dashboard** — free access to tool documentation at [tiger.upsonic.co](https://tiger.upsonic.co) + +### How do I install Tiger? + +```bash +pip3 install upsonic +``` + +Then use the Tiger object to get tools: +```python +from upsonic import Tiger +tools = Tiger().crewai() # For crewAI +tools = Tiger().langchain() # For LangChain +``` + +### What built-in tools are available? + +Tiger provides tools in several categories: + +**App**: open, close + +**Browser**: open_url + +**Interpreter**: Python (check_package, execute, install_package), Shell (execute) + +**Search**: Google, DuckDuckGo, read_website + +**System**: os_name, architecture, python_version, clipboard (copy) + +**Knowledge**: put, pull, delete, index, reset + +**Communication**: Telegram (as_user: delete_message, get_last_dialogs, get_last_messages, send_message, signin) + +### How do I use Tiger with crewAI? + +```python +from upsonic import Tiger +from crewai import Agent, Task, Crew + +# Get Tiger tools +tools = Tiger().crewai() + +# Create agent with Tiger tools +agent = Agent( + role="Researcher", + goal="Research topics", + tools=tools +) +``` + +### How do I use Tiger with LangChain? + +```python +from upsonic import Tiger +from langchain.agents import AgentExecutor + +# Get Tiger tools +tools = Tiger().langchain() + +# Use with LangChain agent +agent_executor = AgentExecutor.from_agent_and_tools(agent, tools) +``` + +### How do I use Tiger with AutoGen? + +```python +from upsonic import Tiger + +# Get Tiger tools +tools = Tiger().autogen(chatbot, userproxy) +``` + +### What is the Public Tiger Dashboard? + +The **Public Tiger Dashboard** at [tiger.upsonic.co](https://tiger.upsonic.co) provides: +- Tool documentation and READMEs +- Function search and discovery +- CPU/RAM usage for each function + +**Auth**: username: `tiger`, password: `tiger` + +### How do I create custom tools? + +To create custom tools for your own Tiger: + +1. Install Upsonic On-Prem Docker container +2. Use Upsonic Client to connect +3. Add your custom functions +4. Tools will be auto-documented in your dashboard + +See [Installation document](https://docs.upsonic.co/on-prem/getting_started/install_on_prem) for details. + +### Does Tiger require API keys? + +**No!** Tiger aims to create tools without API keys — tools work like normal human events: +- Mouse and keyboard control +- Browser automation +- Local Python/Shell execution +- File operations + +This makes Tiger ideal for testing and experimentation without API costs. + +### Can I use Tiger with Telegram? + +Yes! Tiger includes Telegram tools: +```python +from upsonic import Tiger +tools = Tiger() + +# Sign in to Telegram +tools.telegram_signin() + +# Use Telegram tools +tools.telegram_send_message(chat_id, message) +tools.telegram_get_last_messages(chat_id) +``` + +See [Signin to Telegram](#signin-to-telegram) for detailed setup. + +### What is Upsonic? + +Upsonic is the underlying platform that powers Tiger: +- **Tool storage** — isolated storage for tool code +- **Auto-documentation** — generates docs for each function +- **Profiling** — CPU/RAM usage tracking +- **On-Prem option** — self-hosted for privacy + +### How do I get help? + +- **Public Dashboard**: [tiger.upsonic.co](https://tiger.upsonic.co) +- **Documentation**: [docs.upsonic.co](https://docs.upsonic.co) +- **GitHub Issues**: [Upsonic/Tiger/issues](https://github.com/Upsonic/Tiger/issues) +- **Upsonic Community**: [upsonic.co](https://upsonic.co) + +### How can I contribute? + +See [Adding Tools](#adding-tools) section to: +- Add new tools to the public Tiger +- Improve existing tools +- Submit bug fixes +- Enhance documentation + +### What license does Tiger use? + +Tiger is open-source with **MIT License** — free for personal and commercial use. + ## Star History