xojo-ide

Drive a running Xojo IDE from the command line to analyze, build, and run projects.

8|Updated Aug 12, 2026
One-click install
npx skills add https://github.com/scannedinc/xojo-tools --skill xojo-ide-scannedinc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: xojo-ide
Source: https://github.com/scannedinc/xojo-tools/tree/main/plugins/xojo/skills/xojo-ide
Command: npx skills add https://github.com/scannedinc/xojo-tools --skill xojo-ide-scannedinc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? The Xojo IDE cannot be scripted from CI pipelines or AI agents through its GUI alone, and its IDE Communicator protocol has undocumented behaviors that break naive clients. This Skill provides xojoctl, a Python tool that speaks IDE Communicator protocol v2 over the IDE's socket, returning structured errors, warnings, and build results as JSON. ## Core Features & Use Cases - Project lifecycle control: Open, save, close, and reload projects, list and switch the frontmost workspace, and run or stop the project in the IDE debugger. - Analyze and build automation: Run Analyze Project to collect errors and warnings, build for one or more targets such as darwin-arm64, and send arbitrary IDE Scripts, all with one JSON document per command for scripting. - Safe editing workflow: Reload the IDE after editing project files on disk so the IDE never runs stale code or saves over your edits, with a bracketed analyze --project session for clean checkpoints. - Use Case: In continuous integration, run xojoctl analyze --json on a Xojo project and pipe the diagnostics to jq to fail the build whenever errors are reported. ## Quick Start Ask the agent to check that the Xojo IDE is reachable and then analyze the currently open project, reporting any errors and warnings it finds.

Frequently Asked Questions about xojo-ide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build a Xojo project from the command line?

Use xojoctl build with one or more --target flags such as darwin-arm64 while the Xojo IDE is running. Each target reports the path of the artifact it produced, and xojoctl targets lists every supported build target offline.

How to run Xojo Analyze Project from CI or a script?

Run xojoctl analyze --json to get one JSON document containing all errors and warnings. Errors exit with code 1, warnings alone exit 0, and the -W flag makes warnings fail the command too.

Does xojoctl work on Windows, macOS, and Linux?

xojoctl supports macOS and Linux over an AF_UNIX socket at /tmp/XojoIDE, and Windows over a loopback TCP port it discovers automatically. Windows works but is the least tested platform.

Why does the Xojo IDE ignore my edits to project files on disk?

The IDE loads the project into memory and never watches the disk, so it keeps running its stale copy. Run xojoctl reload --discard after disk edits, and never run save before reloading or the IDE overwrites your changes.

Can xojoctl start the Xojo IDE if it is not running?

No. The IDE must already be running because it creates the communication socket that xojoctl dials. Nothing in the IDE Communicator protocol can launch the IDE for you.

What are the limitations of Xojo IDE Communicator automation?

The protocol cannot report build warnings, only analyze does, and it cannot explain why a build produced no output. The IDE also pushes unsolicited messages, so you should not interact with the IDE during unattended runs.