o-o

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 14 Open GitHub ↗

Self-updating articles concept using polyglot html/bash files. No server, no db. The file is the app.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# o-o
*looky-looky*

[**Live demo**](https://jahala.github.io/o-o/example/index.o-o.html)

Each `.o-o.html` file is a self-updating living document — open it in a browser to read, run it with `bash` to update.

```
open  article.o-o.html   # read it
bash  article.o-o.html   # update it
```

No build step, no server, no database. The file *is* the app.

Every `.o-o.html` is a polyglot — valid HTML *and* valid bash. The browser renders a formatted article with TOC, citations, and embedded images. Bash reads an embedded update contract, launches an LLM research agent, and the agent edits the article in-place with fresh information from the web.

## Quick Start

```bash
# Update an existing document
bash example/anthropic-leadership.o-o.html

# Create a new living document
bash example/index.o-o.html --new "SpaceX Starship / Development progress and mission timeline"

# Update all stale documents
bash example/index.o-o.html --update-all
```

## How It Works

```
┌─────────────────────────────────────────┐
│  Shell preamble (hidden from browser    │  ← bash reads this
│  via : << 'OO_HTML' heredoc)            │
├──  ────────────┤
│  Unified CSS (article + index styles)   │  ← browser renders this
├─────────────────────────────────────────┤
│  HTML: header, article content          │
│  Manifest JSON                          │
├──  ─────────────┤
│  Unified JS (TOC, citations, search)    │
├─────────────────────────────────────────┤
│  Contract JSON                          │
├── window.stop() ────────────────────────┤
│  Machine-readable zone                  │  ← agent reads this
│  (source cache, changelog)              │
├── OO_HTML ──────────────────────────────┤
├── # OO:SHELL:START/END ─────────────────┤
│  Unified shell (template, sync, index,  │  ← bash runs this
│  update, arg parsing, agent dispatch)   │
└─────────────────────────────────────────┘
```

Every file carries the complete toolset. Shared sections (CSS, JS, shell) are wrapped in `OO:` markers so they can be replaced programmatically across all files with `--sync`.

When you run `bash file.o-o.html`:

1. The shell preamble hides the HTML via a heredoc
2. The shell code at the bottom parses flags and extracts the budget
3. It launches `claude -p` with a minimal prompt: *read the file yourself*
4. The agent reads the embedded contract, searches the web, and edits the article in-place

The agent never receives the whole file as prompt context — it reads the file itself and surgically modifies the `<article>`, manifest, source cache, and changelog.

## The Update Contract

Each document embeds a JSON contract that controls the agent:

```json
{
  "identity": { "subject": "...", "scope": "...", "audience": "...", "tone": "..." },
  "research": { "intents": ["..."], "required_sections": ["..."], "source_policy": {...} },
  "budget":   { "max_cost_usd": 0.50 },
  "images":   { "allow": true, "max_per_article": 8, "resize_max_px": 800 }
}
```

The manifest tracks update frequency — `"update_every_days": 7` means the file self-checks and won't spend money if it was updated less than 7 days ago. Use `--force` to override.

Click the **version badge** in any document's header to inspect its contract in-browser.

## Index / Library Manager

Any file named `index*.o-o.html` automatically becomes a library manager — a browsable card-grid and management CLI:

```bash
bash index.o-o.html                                    # Rebuild index
bash index.o-o.html --new "Topic / extended scope"     # Create new document
bash index.o-o.html --new                              # Create (interactive)
bash index.o-o.html --update-all                       # Update stale documents
bash index.o-o.html --update-all --force               # Force update all
```

## Options

```
bash document.o-o.html [OPTIONS]

--sync SECTION  Sync shared code to all sibling files (css, js, shell, all)
  --agent NAME    Agent backend (default: claude)
  --model NAME    Override model (e.g. opus, sonnet, haiku)
  --force         Update even if not due yet
  --help, -h      Show help
```

## Sync

All `.o-o.html` files share the same CSS, JS, and shell code. Edit any file, then propagate:

```bash
bash any-file.o-o.html --sync all       # Sync CSS, JS, and shell to siblings
bash any-file.o-o.html --sync css       # Sync just CSS
```

Drop an `oo.css` file in the same directory to add custom styles (theming, dark mode). It gets injected automatically during `--sync css`.

## Requirements

- **bash 3.2+** (ships with macOS) or any modern Linux bash
- **[Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code)** (`claude` command)

No Python, Node, jq, or GNU coreutils. Portable across macOS and Linux.

## Ideas

- A self-updating competitive intel brief on your main rival
- A sentinel doc that watches for a regulatory ruling and alerts when it drops
- A living product comparison that re-benchmarks every month
- A due diligence file on a company you're evaluating
- A weekly team briefing that writes itself
- A personal wiki that keeps itself current

## On the Roadmap

- **`cron` + o-o** — fully hands-off updates on a schedule (`0 6 * * 1 bash ~/docs/*.o-o.html`)
- **GitHub Actions** — auto-update docs in a repo, commit the diff, open a PR with the changelog
- **Diff viewer** — visual side-by-side showing exactly what changed between versions

## Cost

Each update costs **$0.50–$3.00** depending on scope and model. The budget is embedded in the contract — set it once, forget it.

## Support

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/jahala)

## License

MIT

o-o

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README