Skip to content

Getting Started Install

Truong Giang Vu edited this page May 31, 2026 · 1 revision

Install And First Run

Install

  1. Download the latest installer from GitHub Releases.
  2. Run the MSI installer.
  3. Start the target Autodesk host.
  4. Open the RevitDevTool or DevTools panel from the host UI.

First Run

Typical workflow (applies to both Revit and AutoCAD-family hosts):

  1. Open the RevitDevTool dockable panel.
  2. Add script folders or assembly folders in settings.
  3. Pick a discovered command.
  4. Run it.
  5. Inspect trace output, log output, and optional geometry visualization.

Script Folder Rules

The shared script provider discovers script entry files by suffix:

Script type Entry suffix
CPython *script.py
IronPython *_ipy_script.py
C# script *script.csx
F# script *script.fsx

Folders without a supported entry script are skipped.

Python Dependencies

Use PEP 723 metadata at the top of a Python script:

# /// script
# dependencies = ["polars", "numpy"]
# ///

The runtime prepares dependencies before execution. Current behavior is Pixi-first with pip/pyRevit CPython fallback.

Debugging Python

Python debugging uses VSCode/debugpy integration when enabled.

The high-level workflow is:

  1. Start VSCode debugger attach configuration.
  2. Run the Python script from RevitDevTool.
  3. Breakpoints should be hit when the debugger connects.

If debugging does not attach, check debugger port configuration, local firewall/security policy, and whether debugpy was installed into the active runtime.

Clone this wiki locally