Skip to content
/ rune Public

Open Intelligent Coding Agent That Runs in Your Terminal

License

Notifications You must be signed in to change notification settings

sagea-ai/rune

Repository files navigation

Rune

PyPI Version Python Version CI Status License

 ░ ░░  ░░░░░░   ░   ░ ░     ░   ░   ░   ░░          ░  ░░     ░  ░ ░  ░  ░  ░          ░         ░
    ░  ░░▒█▓░░ ░░     ░░░░░░░░░░░░░░░░░   ░░░░░░░   ░ ░░░░░░░░░░░░░░     ░░░░░░░ ░░░░░░░░░░░░░░░░░░░
     ░░▒▓▒██▒█▒░░  ░   ▒██████████████▒░░ ░████▓░ ░  ░░▓████░░▓████░░░   ░▒████▒ ▒████████████████▓░
   ░░▒▒██▒██▒█▓▒▒░     ▒████▓░    ░░█████░░████▓░  ░░░░▓████░░▓███████░  ░▒████▒ ▒████▓░░        ░
 ░░░▓█▓▓█▒▒▒▒█▓▓█▒░░  ░▒████▓░     ░█████ ░████▓░░    ░▓████░░▓███████▓▓░░▒████▒ ▒████▓░  ░    ░░ ░
 ░█▓▓█▒░▓▓░░▓▒░▓█▓▓▓░ ░▒████▓░   ▒▓▓█████ ░████▓░    ░░▓████░░▓████▓▒▓██▓▓▓████▒ ▒█████▓▓▓▓▓▓▓▓▓░░
 ░▒▓▓██▒░▒█▓░░▒██▓▓█▒  ▒████▓░░░░▓██████▓ ░████▓░    ░░▓████░░▓████░ ░█████████▒ ▒██████████████░░
░▒█▓░▓██▓▒█▓▒███▒▒▓█▒  ▒████████████  ░   ░████▓░ ░ ░ ░▓████░░▓████░  ░░███████▒ ▒████▓░░░
 ▒██░░░▓██████▓░░▒██▒ ░▒████▓░░███████▒   ░████▓░    ░░▓████░░▓████░ ░ ░░░▒████▒ ▒████▓░    ░
 ░▓██▓░░░███▓░░▒███▒░  ▒████▓░░▒▒▓█████▓▒ ░▒▒▓██▓▓▓▓▓▓▓██▓▒▒░░▓████░     ░▒████▒ ▒█████▓▓▓▓▓▓▓▓▓▓▓▒░
  ░░▓██▓▒▒██▒▒███▓░░  ░░▓▓▓▓▒░░  ▒▓▓▓▓▓▓▒   ░░▓▓▓▓▓▓▓▓▓▓▓▒░░░ ▒▓▓▓▓░  ░  ░░▓▓▓▓▒ ░▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▒░
 ░  ░░░░░░░░░░░░░░       ░                       ░  ░ ░ ░        ░      ░  ░       ░  ░  ░ ░

Local-first CLI coding assistant powered by SAGE models from SAGEA.

Rune is a command-line coding assistant that brings SAGEA's powerful SAGE models to your local machine. It allows you to use natural language to explore, modify, and interact with your projects through a comprehensive toolset—all running privately on your own hardware.

Rune uses Ollama as the local runtime glue to execute these advanced models efficiently.

Warning

Rune works on Windows, but we officially support and target UNIX environments.

One-line install (recommended)

Linux and macOS

curl -LsSf https://sagea.space/rune-cli/install.sh | bash

Windows

First, install uv:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Then, use uv command below.

Using uv

uv tool install rune-cli

Using pip

pip install rune-cli

Table of Contents

Features

  • Powered by SAGE: Leverages SAGEA's state-of-the-art SAGE Reasoning models for deep understanding of code and logic.
  • 100% Local & Private: All processing happens on your machine using the Ollama runtime. Your code never leaves your computer.
  • Interactive Chat: A conversational AI agent that actively reasons about your requests and breaks down complex tasks.
  • Powerful Toolset: A suite of tools for file manipulation, code searching, version control, and command execution, right from the chat prompt.
    • Read, write, and patch files (read_file, write_file, search_replace).
    • Execute shell commands in a stateful terminal (bash).
    • Recursively search code with grep (with ripgrep support).
    • Manage a todo list to track the agent's work.
    • Ask interactive questions to gather user input (ask_user_question).
    • Delegate tasks to subagents for parallel work (task).
  • Project-Aware Context: Rune automatically scans your project's file structure and Git status to provide relevant context to the agent, improving its understanding of your codebase.
  • Advanced CLI Experience: Built with modern libraries for a smooth and efficient workflow.
    • Autocompletion for slash commands (/) and file paths (@).
    • Persistent command history.
    • Beautiful themes.
  • Highly Configurable: Customize models, providers, tool permissions, and UI preferences through a simple config.toml file.
  • Safety First: Features tool execution approval.
  • Multiple Built-in Agents: Choose from different agent profiles tailored for specific workflows.

Built-in Agents

Rune comes with several built-in agent profiles, each designed for different use cases:

  • default: Standard agent that requires approval for tool executions. Best for general use.
  • plan: Read-only agent for exploration and planning. Auto-approves safe tools like grep and read_file.
  • accept-edits: Auto-approves file edits only (write_file, search_replace). Useful for code refactoring.
  • auto-approve: Auto-approves all tool executions. Use with caution.

Use the --agent flag to select a different agent:

rune --agent plan

Subagents and Task Delegation

Rune supports subagents for delegating tasks. Subagents run independently and can perform specialized work without user interaction, preventing the context from being overloaded.

The task tool allows the agent to delegate work to subagents:

> Can you explore the codebase structure while I work on something else?

🤖 I'll use the task tool to delegate this to the explore subagent.

> task(task="Analyze the project structure and architecture", agent="explore")

Create custom subagents by adding agent_type = "subagent" to your agent configuration. Rune comes with a built-in subagent called explore, a read-only subagent for codebase exploration used internally for delegation.

Interactive User Questions

The ask_user_question tool allows the agent to ask you clarifying questions during its work. This enables more interactive and collaborative workflows.

> Can you help me refactor this function?

🤖 I need to understand your requirements better before proceeding.

> ask_user_question(questions=[{
    "question": "What's the main goal of this refactoring?",
    "options": [
        {"label": "Performance", "description": "Make it run faster"},
        {"label": "Readability", "description": "Make it easier to understand"},
        {"label": "Maintainability", "description": "Make it easier to modify"}
    ]
}])

The agent can ask multiple questions at once, displayed as tabs. Each question supports 2-4 options plus an automatic "Other" option for free text responses.

Prerequisites

Rune requires the Ollama runtime to be installed and running on your system to serve SAGE models.

Installing Ollama

Linux & macOS:

curl -fsSL https://ollama.com/install.sh | sh

Windows: Download the installer from ollama.com

Starting Ollama

After installation, start the Ollama service:

ollama serve

Required Models (SAGE)

Rune is designed to work best with SAGE Reasoning models. Please download the recommended model for your hardware:

# Recommended for most modern machines (32GB+ RAM)
ollama pull comethrusws/sage-reasoning:32b

# Balanced for standard machines (16GB RAM)
ollama pull comethrusws/sage-reasoning:14b

# Lightweight for older machines (8GB RAM)
ollama pull comethrusws/sage-reasoning:8b

Terminal Requirements

Rune's interactive interface requires a modern terminal emulator. Recommended terminal emulators include:

  • WezTerm (cross-platform)
  • Alacritty (cross-platform)
  • Ghostty (Linux and macOS)
  • Kitty (Linux and macOS)

Most modern terminals should work, but older or minimal terminal emulators may have display issues.

Quick Start

  1. Ensure Ollama is running:

    ollama serve
  2. Navigate to your project's root directory:

    cd /path/to/your/project
  3. Run Rune:

    rune
  4. If this is your first time running Rune, it will create a default configuration file at ~/.rune/config.toml configured to use Ollama.

  5. Start interacting with the agent!

    > Can you find all instances of the word "TODO" in the project?
    
    🤖 The user wants to find all instances of "TODO". The `grep` tool is perfect for this. I will use it to search the current directory.
    
    > grep(pattern="TODO", path=".")
    
    ... (grep tool output) ...
    
    🤖 I found the following "TODO" comments in your project.
    

Usage

Interactive Mode

Simply run rune to enter the interactive chat loop.

  • Multi-line Input: Press Ctrl+J or Shift+Enter for select terminals to insert a newline.
  • File Paths: Reference files in your prompt using the @ symbol for smart autocompletion (e.g., > Read the file @src/agent.py).
  • Shell Commands: Prefix any command with ! to execute it directly in your shell, bypassing the agent (e.g., > !ls -l).
  • External Editor: Press Ctrl+G to edit your current input in an external editor.
  • Tool Output Toggle: Press Ctrl+O to toggle the tool output view.
  • Todo View Toggle: Press Ctrl+T to toggle the todo list view.
  • Auto-Approve Toggle: Press Shift+Tab to toggle auto-approve mode on/off.

You can start Rune with a prompt using the following command:

rune "Refactor the main function in cli/main.py to be more modular."

Note: The --auto-approve flag automatically approves all tool executions without prompting. In interactive mode, you can also toggle auto-approve on/off using Shift+Tab.

Trust Folder System

Rune includes a trust folder system to ensure you only run the agent in directories you trust. When you first run Rune in a new directory which contains a .rune subfolder, it may ask you to confirm whether you trust the folder.

Trusted folders are remembered for future sessions. You can manage trusted folders through its configuration file ~/.rune/trusted_folders.toml.

This safety feature helps prevent accidental execution in sensitive directories.

Programmatic Mode

You can run Rune non-interactively by piping input or using the --prompt flag. This is useful for scripting.

rune --prompt "Refactor the main function in cli/main.py to be more modular."

By default, it uses auto-approve mode.

Programmatic Mode Options

When using --prompt, you can specify additional options:

  • --max-turns N: Limit the maximum number of assistant turns. The session will stop after N turns.
  • --enabled-tools TOOL: Enable specific tools. In programmatic mode, this disables all other tools. Can be specified multiple times. Supports exact names, glob patterns (e.g., bash*), or regex with re: prefix (e.g., re:^custom_.*$).
  • --output FORMAT: Set the output format. Options:
    • text (default): Human-readable text output
    • json: All messages as JSON at the end
    • streaming: Newline-delimited JSON per message

Example:

rune --prompt "Analyze the codebase" --max-turns 5 --output json

Slash Commands

Use slash commands for meta-actions and configuration changes during a session.

Built-in Slash Commands

Rune provides several built-in slash commands. Use slash commands by typing them in the input box:

> /help

Common slash commands:

  • /help - Show available commands
  • /statistics - View session statistics
  • /reset - Reset the conversation
  • /model <name> - Switch to a different Ollama model

Custom Slash Commands via Skills

You can define your own slash commands through the skills system. Skills are reusable components that extend Rune's functionality.

To create a custom slash command:

  1. Create a skill directory with a SKILL.md file
  2. Set user-invocable = true in the skill metadata
  3. Define the command logic in your skill

Example skill metadata:

---
name: my-skill
description: My custom skill with slash commands
user-invocable: true
---

Custom slash commands appear in the autocompletion menu alongside built-in commands.

Skills System

Rune's skills system allows you to extend functionality through reusable components. Skills can add new tools, slash commands, and specialized behaviors.

Rune follows the Agent Skills specification for skill format and structure.

Creating Skills

Skills are defined in directories with a SKILL.md file containing metadata in YAML frontmatter. For example, ~/.rune/skills/code-review/SKILL.md:

---
name: code-review
description: Perform automated code reviews
license: MIT
compatibility: Python 3.12+
user-invocable: true
allowed-tools:
  - read_file
  - grep
  - ask_user_question
---

# Code Review Skill

This skill helps analyze code quality and suggest improvements.

Skill Discovery

Rune discovers skills from multiple locations:

  1. Global skills directory: ~/.rune/skills/
  2. Local project skills: .rune/skills/ in your project
  3. Custom paths: Configured in config.toml
skill_paths = ["/path/to/custom/skills"]

Managing Skills

Enable or disable skills using patterns in your configuration:

# Enable specific skills
enabled_skills = ["code-review", "test-*"]

# Disable specific skills
disabled_skills = ["experimental-*"]

Skills support the same pattern matching as tools (exact names, glob patterns, and regex).

Configuration

Configuration File Location

Rune is configured via a config.toml file. It looks for this file first in ./.rune/config.toml and then falls back to ~/.rune/config.toml.

Ollama Setup

Rune uses Ollama by default. The default configuration connects to Ollama at http://localhost:11434.

Basic Ollama configuration in config.toml:

active_model = "sage-reasoning:32b"

[[providers]]
name = "ollama"
api_base = "http://localhost:11434"
backend = "ollama"

[[models]]
name = "sage-reasoning:32b"
provider = "ollama"
alias = "default"

Switching Models

You can switch models during a session:

> /model sage-reasoning:14b

Or configure multiple models:

[[models]]
name = "sage-reasoning:32b"
provider = "ollama"

[[models]]
name = "deepseek-coder-v2"
provider = "ollama"
alias = "deepseek"

Then switch with: /model deepseek

Custom System Prompts

You can create custom system prompts to replace the default one (prompts/cli.md). Create a markdown file in the ~/.rune/prompts/ directory with your custom prompt content.

To use a custom system prompt, set the system_prompt_id in your configuration to match the filename (without the .md extension):

# Use a custom system prompt
system_prompt_id = "my_custom_prompt"

This will load the prompt from ~/.rune/prompts/my_custom_prompt.md.

Custom Agent Configurations

You can create custom agent configurations for specific use cases (e.g., specialized tasks) by adding agent-specific TOML files in the ~/.rune/agents/ directory.

To use a custom agent, run Rune with the --agent flag:

rune --agent my_custom_agent

Rune will look for a file named my_custom_agent.toml in the agents directory and apply its configuration.

Example custom agent configuration (~/.rune/agents/reviewer.toml):

# Custom agent configuration for code review
active_model = "sage-reasoning:32b"
system_prompt_id = "reviewer"

# Disable some tools for this agent
disabled_tools = ["search_replace", "write_file"]

# Override tool permissions for this agent
[tools.bash]
permission = "ask"

[tools.read_file]
permission = "always"

Note: This implies that you have set up a reviewer prompt named ~/.rune/prompts/reviewer.md.

Tool Management

Enable/Disable Tools with Patterns

You can control which tools are active using enabled_tools and disabled_tools. These fields support exact names, glob patterns, and regular expressions.

Examples:

# Only enable specific tools (glob)
enabled_tools = ["read_file", "grep", "bash"]

# Regex (prefix with re:) — matches full tool name (case-insensitive)
enabled_tools = ["re:^custom_.*$"]

# Disable a group with glob; everything else stays enabled
disabled_tools = ["mcp_*"]

Notes:

  • MCP tool names use underscores, e.g., server_list not server.list.
  • Regex patterns are matched against the full tool name using fullmatch.

MCP Server Configuration

You can configure MCP (Model Context Protocol) servers to extend Rune's capabilities. Add MCP server configurations under the mcp_servers section:

# Example MCP server configurations
[[mcp_servers]]
name = "my_http_server"
transport = "http"
url = "http://localhost:8000"
headers = { "Authorization" = "Bearer my_token" }

[[mcp_servers]]
name = "fetch_server"
transport = "stdio"
command = "uvx"
args = ["mcp-server-fetch"]
env = { "DEBUG" = "1", "LOG_LEVEL" = "info" }

Supported transports:

  • http: Standard HTTP transport
  • streamable-http: HTTP transport with streaming support
  • stdio: Standard input/output transport (for local processes)

Key fields:

  • name: A short alias for the server (used in tool names)
  • transport: The transport type
  • url: Base URL for HTTP transports
  • headers: Additional HTTP headers
  • command: Command to run for stdio transport
  • args: Additional arguments for stdio transport
  • startup_timeout_sec: Timeout in seconds for the server to start and initialize (default 10s)
  • tool_timeout_sec: Timeout in seconds for tool execution (default 60s)
  • env: Environment variables to set for the MCP server of transport type stdio

MCP tools are named using the pattern {server_name}_{tool_name} and can be configured with permissions like built-in tools:

# Configure permissions for specific MCP tools
[tools.fetch_server_get]
permission = "always"

[tools.my_http_server_query]
permission = "ask"

Session Management

Session Continuation and Resumption

Rune supports continuing from previous sessions:

  • --continue or -c: Continue from the most recent saved session
  • --resume SESSION_ID: Resume a specific session by ID (supports partial matching)
# Continue from last session
rune --continue

# Resume specific session
rune --resume abc123

Session logging must be enabled in your configuration for these features to work.

Working Directory Control

Use the --workdir option to specify a working directory:

rune --workdir /path/to/project

This is useful when you want to run Rune from a different location than your current directory.

Update Settings

Auto-Update

Rune includes an automatic update feature that keeps your installation current. This is enabled by default.

To disable auto-updates, add this to your config.toml:

enable_auto_update = false

Custom Rune Home Directory

By default, Rune stores its configuration in ~/.rune/. You can override this by setting the RUNE_HOME environment variable:

export RUNE_HOME="/path/to/custom/rune/home"

This affects where Rune looks for:

  • config.toml - Main configuration
  • agents/ - Custom agent configurations
  • prompts/ - Custom system prompts
  • tools/ - Custom tools
  • logs/ - Session logs
  • trusted_folders.toml - Trusted folder list

Editors/IDEs

Rune can be used in text editors and IDEs that support Agent Client Protocol. See the ACP Setup documentation for setup instructions for various editors and IDEs.

Supported editors:

  • Zed
  • JetBrains IDEs (IntelliJ, PyCharm, etc.)
  • Neovim
  • VS Code (via extensions)

Resources

License

Copyright SAGEA

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE file for the full license text.

About

Open Intelligent Coding Agent That Runs in Your Terminal

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages