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-cliOr using pnpm:
pnpm add -g omniscript-cli💡 Tip: Use pnpm for faster installs and better disk space usage.
2. Verify Installation
osf --versionYou should see output like:
omniscript-cli v1.1.03. Install VSCode Extension (Recommended)
For the best development experience, install the official VSCode extension.
Option A: From Marketplace
- Open Visual Studio Code
- Press Ctrl+Shift+X(Windows/Linux) orCmd+Shift+X(Mac)
- Search for "OmniScript Format"
- Click Install
Option B: Command Line
code --install-extension OmniScriptOSF.omniscript-vscode4. Library Installation (Optional)
For programmatic usage in your Node.js projects:
Parser Only
npm install omniscript-parserWith Converters
npm install omniscript-parser omniscript-converters5. Next Steps
System Requirements
Node.js
Version 18 or higher
Operating System
Windows, macOS, Linux
VSCode
Version 1.80 or higher