ollie/README.md

2.0 KiB
Raw Blame History

Ollie Monorepo

This repository contains all Ollie projects as submodules:

  • core/ – The core Ollie agent library (ollie-core)
  • tui/ – Terminal UI frontend (ollie-tui)
  • 9p/ – 9p filesystem server (ollie-9p)
  • el/ – Emacs Lisp interface (ollie-el)

Getting Started

Clone with submodules:

git clone --recurse-submodules https://github.com/lneely/ollie.git

Or after cloning:

git submodule update --init --recursive

Building

Build everything from the monorepo root:

mk

Or build specific components:

mk core    # Build core library
mk tui     # Build terminal UI
mk 9p      # Build 9p filesystem server

For Emacs Lisp, load el/ollie.el in Emacs.

Development

Update all submodules to latest:

git submodule update --remote

Project Structure

  • core/: Core agent library (Go)
  • tui/: Terminal UI (Go)
  • 9p/: 9p filesystem server (Go)
  • el/: Emacs Lisp interface (Emacs Lisp)

Credits

Many sources of inspiration:

  • Plan 9 from Bell Labs — for an interesting system
  • @9fans — for the Plan 9 port
  • Suckless — for articulating good software development principles
  • @simonfxr — for a solid agent baseline to "borrow" from, and other nifty ideas
  • @aws — for a solid open-source agent implementation

License

GPLv3