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. Install VSCode Extension (Recommended)

For the best development experience, install the official VSCode extension.

Option A: From Marketplace

  1. Open Visual Studio Code
  2. Press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (Mac)
  3. Search for "OmniScript Format"
  4. Click Install

Option B: Command Line

code --install-extension OmniScriptOSF.omniscript-vscode

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

System Requirements

Node.js

Version 18 or higher

Operating System

Windows, macOS, Linux

VSCode

Version 1.80 or higher