https://github.com/hlfshell/arkaine
arkaine is AI for makers - a framework for small composable agents
https://github.com/hlfshell/arkaine
agents ai llms makers
Last synced: 9 months ago
JSON representation
arkaine is AI for makers - a framework for small composable agents
- Host: GitHub
- URL: https://github.com/hlfshell/arkaine
- Owner: hlfshell
- License: mit
- Created: 2024-11-09T01:30:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-25T02:10:20.000Z (about 1 year ago)
- Last Synced: 2025-10-14T19:06:39.592Z (9 months ago)
- Topics: agents, ai, llms, makers
- Language: Python
- Homepage:
- Size: 871 KB
- Stars: 17
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# arkaine
Empower your summoned AI agents. arkaine is a batteries-included framework built for DIY builders, individuals, and small scale solutions.
[](https://opensource.org/licenses/MIT)
[](https://www.python.org/downloads/)
[](https://discord.gg/6k7N2sV5xA)
## Overview
arkaine is built to allow individuals with a little python knowledge to easily create deployable AI agents enhanced with tools. While other frameworks are focused on scalable web-scale solutions, arkaine is focused on the smaller scale projects - the prototype, the small cron job, the weekend project. arkaine attempts to be batteries included - multiple features and tools built in to allow you to go from idea to execution rapidly.
# [📖 Documentation 👩🏫](https://arkaine.dev)
Documentation can be found at [arkaine.dev](https://arkaine.dev).
## WARNING
This is a *very* early work in progress. Expect breaking changes, bugs, and rapidly expanding features.
## Features
- 🔧 Easy tool creation and programmatic tool prompting for models
- 🤖 Agents can be "composed" by simply combining these tools and agents together
- 🔀 Thread safe async routing built in
- 🔄 Multiple backend implementations for different LLM interfaces
- OpenAI (GPT-3.5, GPT-4)
- Anthropic Claude
- Groq
- Ollama (local models)
- More coming soon...
- 🧰 Built-in common tools (web search, file operations, etc.)
## Key Concepts
- 🔧 **Tools** - Tools are functions (with some extra niceties) that can be called and do something. That's it!
- 🤖 **Agents** - Agents are tools that use LLMS. Different kinds of agents can call other tools, which might be agents themselves!
- **IterativeAgents** - IterativeAgents are multi-shot agents that can repeatedly call an LLM to try and perform its task, where the agent can identify when it is complete with its task.
- 🧰 **BackendAgents** - BackendAgents are agents that utilize a **Backend** to perform its task.
- 💬 **Chats** - Chats are agents that interact with a user over a prolonged interaction in some way, and can be pair with tools, backends, and other agents.
- **Backends** - Backends are systems that empower an LLM to utilize tools and detect when it is finished with its task. You probably won't need to worry about them!
- 📦 **Connectors** - Connectors are systems that can trigger your agents in a configurable manner. Want a web server for your agents? Or want your agent firing off every hour? arkaine has you covered.
- **Context** - Context provides thread-safe state across tools. No matter how complicated your workflow gets by plugging agents into agents, contexts will keep track of everything.
## Installation
To install arkaine, ensure you have Python 3.8 or higher installed. Then, you can install the package using pip:
```bash
bash
pip install arkaine
```