🚀 The Universal Document DSL for LLMs, Agentic AI, and Git-Native Workflows
📖 Documentation • 🚀 Quick Start • 💡 Examples • 🤝 Contributing • 💬 Discussions
OmniScript Format (OSF) revolutionizes document creation by unifying the best features of multiple formats into a single, AI-friendly syntax:
|
Like Markdown & LaTeX
|
Like PowerPoint & Keynote
|
Like Excel & Google Sheets
|
🎯 Current Version:
v0.5.6| 🔥 Status: Active Development | 📅 Next Release: v1.0.0
| Feature | Traditional Formats | OmniScript Format |
|---|---|---|
| 🔄 Version Control | Binary, merge conflicts | ✅ Git-native, meaningful diffs |
| 🤖 AI Integration | Complex parsing | ✅ LLM-friendly syntax |
| 📱 Multi-format Output | Single format only | ✅ Export to DOCX, PPTX, XLSX, MD |
| 🔗 Interoperability | Format silos | ✅ Unified document ecosystem |
| ⚡ Live Formulas | Static content | ✅ Dynamic calculations |
| 🎨 Rich Styling | Limited or complex | ✅ Intuitive theme system |
|
Global CLI Installation npm install -g omniscript-cli
# or
pnpm add -g omniscript-cli |
Library Integration # Core parser only
npm install omniscript-parser
# With professional format converters
npm install omniscript-parser omniscript-converters
# or with pnpm
pnpm add omniscript-parser omniscript-converters |
# Parse and validate OSF files
osf parse examples/rich_demo.osf
# Render to beautiful HTML
osf render examples/rich_demo.osf --format html
# Export to professional formats (requires omniscript-converters)
osf render examples/rich_demo.osf --format docx --output report.docx
osf render examples/rich_demo.osf --format pptx --output slides.pptx
osf render examples/rich_demo.osf --format xlsx --output data.xlsx
osf render examples/rich_demo.osf --format pdf --output document.pdf
# Export to other formats
osf export examples/rich_demo.osf --target md
# Format for consistency
osf format examples/rich_demo.osf🎯 Click to see a complete OSF example
@meta {
title : "Q2 Business Review";
author : "Alphin Tom";
date : "2025-06-07";
theme : "CorporateBlue";
}
@doc {
# Executive Summary
Our Q2 performance exceeded expectations with **15% revenue growth**
and significant improvements in customer retention.
## Key Metrics
- Revenue: $2.3M (+15%)
- Customer Churn: 3% (-2%)
- Team Size: 45 (+8 new hires)
}
@slide {
title : "Q2 Highlights";
layout : TitleAndBullets;
transition : FadeIn;
bullets {
"💰 Revenue grew 15% to $2.3M";
"👥 Customer churn decreased to 3%";
"🚀 Launched 3 major features";
"🌟 Team expanded by 8 members";
}
}
@sheet {
name : "Regional Performance";
cols : [Region, Q1_Revenue, Q2_Revenue, Growth_Percent];
data {
(2,1)="North America"; (2,2)=850000; (2,3)=975000;
(3,1)="Europe"; (3,2)=650000; (3,3)=748000;
(4,1)="Asia Pacific"; (4,2)=400000; (4,3)=477000;
}
formula (2,4): "=(C2-B2)/B2*100";
formula (3,4): "=(C3-B3)/B3*100";
formula (4,4): "=(C4-B4)/B4*100";
}
| Package | Description | Version | Downloads |
|---|---|---|---|
| omniscript-parser | Core parsing library with TypeScript support |  |
 |
| omniscript-cli | Command-line tools with osf binary |
 |
 |
| omniscript-converters | Professional format converters (DOCX, PPTX, XLSX, PDF) |  |
 |
graph TB
A[📝 OSF Source Files] --> B[🔍 Parser]
B --> C[🎯 AST Representation]
C --> D[📊 Renderer]
C --> E[🔄 Transformer]
D --> F[🌐 HTML Output]
D --> G[📄 PDF Output]
E --> H[📝 Markdown]
E --> I[📊 Excel/DOCX]
E --> J[🎨 PowerPoint]
omniscript-core/
├── 📋 spec/ # Versioned specifications
│ ├── v0.5/ # Current stable spec
│ ├── v1.0/ # Next major version
│ └── roadmap.md # Development roadmap
├── 🔍 parser/ # Core parsing engine
├── ⚡ cli/ # Command-line interface
├── 📚 examples/ # Sample OSF documents
├── 🧪 tests/ # Comprehensive test suite
├── 📖 docs/ # Architecture & design docs
└── 🔧 scripts/ # Development & release tools
# Clone the repository
git clone https://github.com/OmniScriptOSF/omniscript-core.git
cd omniscript-core
# Install dependencies
pnpm install
# Build all packages
pnpm run build
# Run tests
pnpm test
# Start development
pnpm run dev📋 For Maintainers
# Patch release (0.5.6 → 0.5.7)
pnpm run release:patch
# Minor release (0.5.6 → 0.6.0)
pnpm run release:minor
# Major release (0.5.6 → 1.0.0)
pnpm run release:majorOur automated release process:
- ✅ Runs comprehensive tests
- ✅ Updates package versions
- ✅ Creates GitHub releases
- ✅ Publishes to npm
- ✅ Updates documentation
| Version | Status | Features | ETA |
|---|---|---|---|
| v0.5 | ✅ Current | Core parsing, CLI tools, basic rendering | Released |
| v1.0 | 🚧 In Progress | Advanced exports, diagram support | Q2 2025 |
| v1.1 | 📋 Planned | Real-time collaboration, plugins | Q3 2025 |
| v2.0 | 💭 Future | Visual editor, cloud integration | 2026 |
- 🎨 Visual Editor - WYSIWYG editing experience
- 📊 Advanced Charts - Interactive data visualizations
- 🔗 Real-time Collaboration - Multi-user editing
- 🧩 Plugin System - Extensible functionality
- ☁️ Cloud Integration - Seamless sync across devices
We ❤️ contributions from the community!
- 🐛 Report bugs via GitHub Issues
- 💡 Suggest features in Discussions
- 📖 Improve documentation
- 🔧 Submit pull requests
- ⭐ Star the repository
MIT License © 2025 Alphin Tom
This project is free and open-source software. We believe in the power of community-driven development.
Maintainer: Alphin Tom | Organization: OmniScriptOSF