OmniScript Format (OSF) - Universal Document DSL for LLMs, Agentic AI, and Git-Native Workflows
🚀 Get Started • 📦 Packages • 💡 Examples • 🤝 Contributing • 🗺️ Roadmap
OmniScript Format (OSF) is revolutionizing how we create, manage, and process documents by unifying the best features of multiple formats into a single, AI-friendly syntax. Think of it as Markdown meets LaTeX meets Excel meets PowerPoint - all in one universal format.
|
Like Markdown & LaTeX
|
Like PowerPoint & Keynote
|
Like Excel & Google Sheets
|
Built for the Future
|
| Challenge | Traditional Approach | OmniScript Solution |
|---|---|---|
| 🔄 Version Control | Binary files, merge conflicts | ✅ Git-native text format with meaningful diffs |
| 🤖 AI Integration | Complex parsing, format chaos | ✅ LLM-optimized syntax for seamless AI workflows |
| 📱 Multi-format Output | One format = one tool | ✅ Single source → Export to DOCX, PPTX, XLSX, PDF, HTML |
| 🔗 Interoperability | Format silos and vendor lock-in | ✅ Universal format that works everywhere |
| ⚡ Dynamic Content | Static documents only | ✅ Live formulas and real-time calculations |
| 🎨 Consistent Styling | Manual formatting headaches | ✅ Theme system with automatic styling |
| Repository | Description | Status | Key Features |
|---|---|---|---|
| omniscript-core | 🔥 Core engine with parser, CLI & specs |  |
Parser, CLI tools, specifications |
| omniscript-converters | 🔄 Professional format converters | ✅ Published | PDF, DOCX, PPTX, XLSX export |
| omniscript-examples | 💡 Real-world examples & templates |  |
Business docs, presentations, reports |
| omniscript-vscode | 🎨 VS Code extension |  |
Syntax highlighting, IntelliSense |
| omniscript-site | 🌐 Official website & documentation | |
Interactive docs, playground |
| Package | Purpose | Version | Downloads | Dependencies |
|---|---|---|---|---|
| omniscript-parser | TypeScript parsing engine |  |
 |
Zero deps |
| omniscript-cli | Command-line tools |  |
 |
Parser + converters |
| omniscript-converters | Professional converters |  |
 |
Parser + formats |
|
🔧 For Developers # Core parsing library
npm install omniscript-parser
# Professional format converters
npm install omniscript-converters
# Both together
npm install omniscript-parser omniscript-converters |
⚡ For Users # Global CLI tools
npm install -g omniscript-cli
# Quick start
osf --help |
# Create a sample document
echo '@meta { title: "Hello OSF"; }
@doc { # Welcome
This is **your first** OSF document! }' > hello.osf
# Parse and validate
osf parse hello.osf
# Render to HTML
osf render hello.osf --output hello.html
# Convert to multiple formats
osf render hello.osf --format docx --output hello.docx
osf render hello.osf --format pptx --output hello.pptx
osf render hello.osf --format xlsx --output hello.xlsx
osf render hello.osf --format pdf --output hello.pdf📋 Business Report
@meta {
title: "Q2 Business Review";
author: "Jane Smith";
date: "2025-06-28";
theme: "CorporateBlue";
}
@doc {
# Executive Summary
Our Q2 performance exceeded expectations with **15% revenue growth**
and significant improvements in customer retention.
## Key Achievements
- Revenue: $2.3M (+15%)
- Customer Churn: 3% (-2%)
- Team Growth: 45 employees (+8)
}
@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";
}
🎯 Product Presentation
@meta {
title: "Product Launch 2025";
author: "Product Team";
theme: "ModernTech";
}
@slide {
title: "Introducing OmniScript";
layout: "TitleAndContent";
content: "The future of document processing is here.";
}
@slide {
title: "Key Features";
layout: "TitleAndBullets";
bullets {
"🚀 Universal document format";
"🤖 AI-native syntax design";
"🔄 Git-friendly version control";
"📊 Multi-format export capabilities";
}
}
📊 Data Analysis
@meta {
title: "Sales Analysis Dashboard";
author: "Analytics Team";
theme: "DataViz";
}
@sheet {
name: "Monthly Sales";
cols: [Month, Sales, Target, Performance];
data {
(1,1)="Jan"; (1,2)=85000; (1,3)=80000;
(2,1)="Feb"; (2,2)=92000; (2,3)=85000;
(3,1)="Mar"; (3,2)=78000; (3,3)=90000;
}
formula (1,4): "=B1/C1*100";
formula (2,4): "=B2/C2*100";
formula (3,4): "=B3/C3*100";
}
| Version | Status | Key Features | ETA |
|---|---|---|---|
| v0.5 | ✅ Released | Core parsing, CLI tools, basic rendering | Current |
| v0.6 | 🚧 In Progress | Converter improvements, enhanced themes | Q3 2025 |
| v1.0 | 📋 Planned | Advanced exports, diagram support, VS Code extension | Q4 2025 |
| v1.1 | 💭 Future | Real-time collaboration, plugin system | Q1 2026 |
| v2.0 | 🌟 Vision | Visual editor, cloud integration, enterprise features | 2026 |
- 🎨 Visual Editor - WYSIWYG editing experience with live preview
- 📊 Advanced Charts - Interactive data visualizations and dashboards
- 🔗 Real-time Collaboration - Multi-user editing with conflict resolution
- 🧩 Plugin System - Extensible architecture for custom functionality
- ☁️ Cloud Integration - Seamless sync across devices and platforms
We ❤️ contributions from developers, designers, writers, and users of all skill levels!
# 1. Fork and clone any repo
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
# 2. Install dependencies
pnpm install
# 3. Create a feature branch
git checkout -b feature/amazing-feature
# 4. Make your changes and test
pnpm run build && pnpm test
# 5. Submit a PR
git push origin feature/amazing-featureMIT License © 2025 OmniScript Organization
🔗 Connect with us: GitHub • Discord • Twitter
Made with ❤️ by the global OmniScript community