Skip to main content

Installation

Get OmniScript Format up and running in minutes.

1. Install the CLI

The fastest way to get started is with the command-line interface.

npm install -g omniscript-cli

Or using pnpm:

pnpm add -g omniscript-cli

💡 Tip: Use pnpm for faster installs and better disk space usage.

2. Verify Installation

osf --version

You should see output like:

omniscript-cli v1.1.0

3. Editor Support (Roadmap)

Dedicated editor tooling (syntax highlighting, IntelliSense, diagnostics) is planned but not released yet. Track progress on the roadmap.

View Roadmap →

4. Library Installation (Optional)

For programmatic usage in your Node.js projects:

Parser Only

npm install omniscript-parser

With Converters

npm install omniscript-parser omniscript-converters

5. Next Steps

📝 Create Your First Document →

Learn OSF basics with a step-by-step tutorial

🎮 Try the Playground →

Experiment with OSF in your browser

System Requirements

Node.js

Version 18 or higher

Operating System

Windows, macOS, Linux

Editor

Any text editor (VS Code support planned)