Getting started

Installation

Run the following command to install Lime:

uvx lime-ai hello.mgx

To install it as a persistent tool:

uv tool install lime-ai

Copilot

Lime is using Copilot (currently), so you will need to have the Copilot CLI installed and configured to use Lime.

Note: Lime will be adding support for other agents in the future, but for now Copilot is the only supported agent.

Your first template

Create a file named hello.mgx with the following content:

---
description: Hello world tutorial for Lime!
---

<<
# Hello World

Tell the user Hello, and welcome them to Lime!
>>

@effect run

lime execute hello.mgx

Note: This template includes metadata, this is optional but recommended for better organization and discoverability. Metadata can contain any key value pair.

The << >> block contains markdown content, this is the main prompt that you will send to the agent.

@effect run is a special instruction that tells the agent to execute.

Once you run the command, you should see the following output in your terminal:

Output

# Hello World

Hello, and welcome to Lime!

Now that you have run your first template, check out some of the other things you can do with Lime.