VSCode Extensions

Two purpose-built Visual Studio Code extensions for working with MikroTik RouterOS — syntax intelligence, a notebook interface, and a growing set of RouterOS-specific tools, all wired directly to a live router.

If you write RouterOS scripts or work with RouterOS configuration from a computer, these extensions are worth trying. Install RouterOS LSP for syntax checking and completions in any .rsc file, then add TikBook for a full notebook and tooling experience. Both are free, open source, and on the VS Code Marketplace.

RouterOS LSP icon

RouterOS LSP FLAGSHIP TypeScript

lsp-routeros-ts — Language Server Protocol for MikroTik RouterOS

RouterOS LSP is a language server that provides syntax highlighting, code completion, real-time diagnostics, and other intelligent editor features for RouterOS scripts (.rsc files) in VS Code, NeoVim, and any LSP-capable editor. By connecting to a live RouterOS device via the REST API, the LSP knows what commands and arguments are valid for your specific RouterOS version — it always stays current, even after a router upgrade.

RouterOS LSP animation showing autocomplete in VS Code
RouterOS LSP providing code completions in VS Code

Supported Features

Install in VS Code

Alternatively, search TIKOCI in the VS Code Extensions panel (Ctrl+Shift+X / ⌘+Shift+X) and select RouterOS LSP.

Setup — connecting to your RouterOS device

RouterOS LSP requires a live RouterOS device accessible via the REST API. By default, RouterOS’s www service runs on port 80 and is reachable from the LAN — so a standard router with default configuration works out of the box using http:// and the admin account.

  1. Open VS Code Settings (Ctrl+, / ⌘+,) and go to Extensions → RouterOS LSP
  2. Set Base URL — e.g. http://192.168.88.1 or https://router.lan
  3. Set Username and Password for a RouterOS account with read, api, rest-api policy

For production routers, HTTPS with a Let’s Encrypt certificate is recommended:

/certificate/enable-ssl-certificate
/ip/service enable www-ssl

For NeoVim and other LSP clients, download the standalone server binary from GitHub Releases.

TikBook icon

TikBook NEW TypeScript

vscode-tikbook — Notebook and Tools for MikroTik RouterOS in VS Code

TikBook is a companion extension to RouterOS LSP, akin to a “plus pack” for VS Code specifically. Installing TikBook automatically brings in RouterOS LSP if it is not already present. TikBook adds a notebook interface for RouterOS scripts, virtual configuration views, CSV exports, JSON converters, and a “Quick Commander” menu — all wired to your live RouterOS device.

TikBook Quick Commander menu
TikBook’s Quick Commander menu — access notebooks, management, and help in one place

What TikBook Adds

TikBook notebook toolbar
The TikBook notebook toolbar — run cells, manage sections, and navigate errors

Install in VS Code

When prompted, select “use pre-release”. If VS Code shows a publisher trust prompt, select “Trust Publisher and Install”.

Connecting TikBook to RouterOS

TikBook, like RouterOS LSP, needs a REST API connection to a RouterOS device running version 7.12 or higher:

  1. Click the MikroTik logo in the VS Code status bar (lower left) — the RouterOS Connection Menu appears
  2. Select “Set Base URL” and enter http://192.168.88.1 (or your router’s address)
  3. Select “Set User” and “Set Password as Secret” to store credentials securely

TikBook shares credentials with RouterOS LSP by default, so both extensions use the same router.

Tip: For local testing without touching a production router, TIKOCI provides ready-to-run RouterOS CHR images for macOS UTM.

winbox-deb Makefile Shell

Packages WinBox 4.0 as a .deb for Linux, with a desktop icon. Provided as a template for packaging WinBox on various Linux distributions, rather than for wide redistribution.

Development Tools

Tools for developing, editing, and working with MikroTik RouterOS — LSP support, API schemas, and code generators.

lsp-routeros-ts NEW TypeScript

A “working prototype” of an LSP server for third-party editors like VSCode and NeoVim. Provides syntax checking and completion for RouterOS scripting language.

LSP demo showing autocomplete in VSCode
RouterOS LSP providing completions in VSCode

The project builds a lsp-routeros-ts.vsix file that can be installed in VSCode:

wget https://github.com/tikoci/lsp-routeros-ts/releases/latest/download/lsp-routeros-ts.vsix
code --install-extension lsp-routeros-ts.vsix

After installing the VSIX, configure the “RouterOS LSP” extension settings to provide a RouterOS device for REST API access. Single-file executables for various OS/platforms are also available for use with other editors.

restraml TypeScript

Generates API schemas for any RouterOS version using CHR in GitHub Actions to dynamically create API schemas from RouterOS’s /console/inspect command. The generated schemas can be used in Postman and other API tools to support RouterOS’s REST API development.

The project also hosts the Schema Diff, Command Lookup, and Schema Downloads pages.

winbox-deb Makefile Shell

Uses Makefile to create a .deb Linux package with WinBox 4.0, including adding an icon to the desktop. Provided mainly as an example for others wanting to package WinBox 4.0 for various distros.

The .deb built is not intended for wide redistribution — more a template for future WinBox packaging.