GitHub

**Terminal AI Commander at your fingertips**
coding assistant example
Checkout demos for more examples.
**NOTE**: This is a work in progress, expect bugs and api changes.
Introduction
Instrukt is a terminal-based AI integrated environment. It offers a platform where users can:
- :robot: Create and instruct modular AI agents
- :card_file_box: Generate document indexes for question-answering
- :toolbox: Create and attach tools to any agent
Agents are simple **drop-in Python packages** that can be extended, shared with others, attached to tools and augmented with document indexes.
Instruct them in natural language and, for safety, run them inside secure containers (currently implemented with Docker) to perform tasks in their dedicated, sandboxed space :shield:.
Built with: Langchain, Textual, Chroma
**Consulting Services**: Need help with Langchain or AI integration ? You can reach out to me at contact@blob42.xyz
TOC
- Usage
- Features
- Supported Platforms
- LLM Models
- Document Indexes and Question-Answering
- Roadmap
- Contributing
- Social
- Vision
- License
Usage
Quickstart
- pip install instrukt[all]
- export OPENAI_API_KEY with your OpenAI API key.
- run instrukt
- If the color scheme is broken, export TERM=xterm-256color
- A configuration file will be created at:
~/.config/instrukt/instrukt.yml
You can run instrukt on headless server such or a docker container with CUDA support.
**NOTE**: if you are starting with a bare container, you need at least g++ and libmagic.
Check the quickstart and install
guide for more details.
From source:
- Make sure the latest version of poetry is installed.
- Set your virtualenv
- Clone the repository
- Run poetry install -E all --with dev,test
- This will install Instrukt including extra tools for agents.
See the installation guide for more details
Default Agents:
**Coding AI**: A coding assistant. Create indexes over any code base and attach it to the agent to do RAG (Retrieval Augmented Generation)
**Chat Q&A**: A simple conversational agent.
Features
:computer: Keyboard and Mouse Terminal Interface:
- A terminal-based interface for power keyboard users to instruct AI agents without ever
leaving the keyboard.
- Rich colorful agent outputs with markdown and
source code support thanks to the Textual TUI
library.
- Run Instrukt on bare metal or docker containers with CUDA support.
- Remote access with SSH and terminal multiplexers.
:robot: Custom AI Agents:
- Design custom agents and tools.
- Agents are simple python packages can be shared and loaded by other users.
:books: Chat with code and documents:
- Index your data and let agents retrieve it for question-answering.
- Create and organize your indexes with an easy UI.
- Index creation will **auto detect programming languages** and optimize the splitting/chunking
strategy accordingly.
- Fuzzy select (fzf, dmenu ...) source documents that were used for retrieval ctrl+p
:wrench: Tools:
- Use the pre-defined toolset or design your own tools.
- Attach or detach tools to agents on-the-go, tailoring your AI workflows to your needs.
:zap: Prompt Console :
- Integrated REPL-Prompt for quick interaction with agents, and a fast feedback loop for development and testing.
- Automate repetitive tasks with custom commands.
- Builtin prompt/chat history.
- Use vim, emacs or any external $EDITOR to edit messages.