Meta Agent Tools
PT

Back to the catalog

Quire Specification

Index of artifacts in this directory.

Open source Repository Open in the app JSON README (API)

About

# Quire Specification

## Contents

- [Spec](./spec.md) — master requirements
- [Stakeholder Requirements](./stakeholder/) — StR-001, StR-002
- [User Stories](./usecase/) — US-001..008, US-010..018
- [Functional Requirements](./functional/) — FR-001..024, FR-027, FR-028
- [Non-Functional Requirements](./non-functional/) — NFR-001..005
- [Test Matrix](./tests.md)
- [Spec Review](./review.md)

Details

Kind
OKF bundles
Topic
Files & documents
Publisher
agent-ix
Origin
okf_github
Category
dados
Version
0.1
Stars
1
Last push
2026-08-14T15:48:03Z
Repository state
ativo
Language
TypeScript
License
MIT
Added
2026-09-08 09:04:14
Updated
2026-09-08 09:04:14
Origin id
agent-ix/quire:spec/index.md

README

<p align="center">
  <img src="logo.png" alt="Quire" width="100%" />
</p>

# @agent-ix/quire

[![Discord](https://img.shields.io/badge/Discord-Join%20us-5865F2?logo=discord&logoColor=white)](https://discord.gg/6qsdhSPE)

> **quire** _(noun)_ — a gathering of sheets, folded together; from Latin _quaternī_ (four each). In bookbinding, the fundamental unit of structure from which a complete volume is assembled.

Structured document interaction library — Parse, query, and render markdown document sections as typed React components.

## What It Does

Quire takes raw markdown content and provides:

- **Parsing** — split documents into a typed section tree
- **Querying** — access sections, tables, lists, and diagrams by name
- **Rich rendering** — render parsed objects as custom React components (badges, icons, interactive tables)
- **Markdown fallback** — sections without custom renderers display via `markdown-editor` (read-only)
- **Write-back** — modify sections and serialize back to markdown

## Architecture

```
Layer 3: React Context     — QuireProvider, SectionCard, SectionTable, AutoSections
Layer 2: Query API         — section(), tables(), lists(), diagrams(), search()
Layer 1: Parser            — parseDocument(), extractFrontmatter(), parseBulletList()
```

Layers 1+2 are pure TypeScript with zero React dependency — usable by agents, scripts, and CLI tools.

## Install

Published on the public npm registry:

```bash
npm install @agent-ix/quire
```

## Development

### Storybook

Run Storybook locally in Docker (exposed at http://quire.ix):

```bash
make storybook
```

Stop Storybook:

```bash
make storybook-stop
```

### Testing

```bash
make test
```

### Build

```bash
make build
```

More