Skip to content

OUIsolutions/VibeScript

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VibeScript

License: MIT GitHub release Build Status PRs Welcome

A custom Lua runtime for rapid LLM-powered automations

FeaturesInstallationQuick StartDocumentationReleasesLicense

📋 Overview

VibeScript is a specialized Lua runtime environment designed to facilitate fast automations through quick scripts. It seamlessly integrates LLM capabilities into Lua, enabling powerful AI-driven workflows with minimal setup.

✨ Features

  • LLM Integration - Direct access to LLM models from Lua scripts
  • File System Operations - Secure read/write capabilities for automation
  • Multi-platform Support - Works on Linux, Windows, and macOS
  • Simple API - Intuitive Lua interface for complex LLM operations
  • Configurable Models - Support for various LLM providers

🚀 Installation

Option 1: Download Pre-built Binaries

Download the latest release from our releases page.

Option 2: Install via Package Manager

Debian/Ubuntu:

# Download the .deb package from releases page
sudo dpkg -i vibescript.deb

Fedora/RHEL:

# Download the .rpm package from releases page
sudo rpm -i vibescript.rpm

🏁 Quick Start

1. Configure an LLM Model

vibescript configure_model --model grok-2-latest --url https://api.x.ai/v1/chat/completions --key "your key"

See CLI usage documentation for more options.

2. Create Your First Script

Create a file named main.lua with the following content:

llm = newLLM({
    read = true,
    write = true,
    execute = true,
    delete = true,
    list = true
})
llm.add_user_prompt("list the src dir, and explain what's inside")
response = llm.generate()
print("Response: " .. response)

3. Run Your Script

vibescript main.lua

Explore the Native API documentation to learn more about VibeScript's capabilities.

📦 Releases

File Description
vibescript.c Amalgamated source code
vibescript.deb Debian Package
vibescript.rpm RPM Package
vibescript.out Linux Executable
vibescript64.exe Windows 64-bit Executable
vibescripti32.exe Windows 32-bit Executable

📚 Documentation

Document Description
Native API LLM creation and usage examples
CLI Usage Command line interface reference
Assets & Embed Variables Asset structure and management
Build Instructions Build requirements and commands
Build Toolchain Build process and dependencies
Build Workflow Build workflow and functions
JSON Model Config JSON configuration structure and encryption
Licenses List of licenses and copyrights
Project Dependencies List of project dependencies
Project Workflow Project start and action functions

🤝 Contributing

Contributions are welcome! Feel free to submit a pull request or open an issue.

📄 License

This project is licensed under the MIT License - see the licenses.md file for details.