IKE Tooling
IKE Build Standards 186

Developer Environment

The canonical "getting started on your machine" page for IKE Network development. It gathers the IDE, operating-system, and command-line setup a contributor needs into one place, so the knowledge is not scattered across per-workspace CLAUDE.md files and folklore.

The page is organised per environment. Each section is independent — read the ones that apply to your machine.

IntelliJ IDEA

IntelliJ is the primary IDE for IKE Java and workspace development.

Maven home — use the Maven wrapper

This is the single most important setting. IKE workspaces build with Maven 4 and POM modelVersion 4.1.0. A Maven 3 binary cannot read that model and the build fails immediately with:

'modelVersion' of '4.1.0' is newer than the version supported
by this Maven installation [4.0.0]

Point IntelliJ at the wrapper that each workspace ships:

  • Settings → Build, Execution, Deployment → Build Tools → Maven
  • Set Maven home path to Use Maven wrapper

The wrapper (.mvn/wrapper/ + mvnw) pins the exact Maven 4 version the workspace expects, so every machine and CI runner builds with the same toolchain.

Install the GraphViz / DOT plugin

ws:overview and ws:graph render the workspace dependency graph as GraphViz DOT (see ike-issues#406 — the renderer is GraphViz, not Mermaid). Install JetBrains' GraphViz / DOT plugin so the generated .dot output previews inside the IDE. Do not install a Mermaid plugin for this — it will not render the workspace graph.

Install the AsciiDoc plugin

IKE documentation is authored in AsciiDoc. Install the AsciiDoc plugin to get live rendered preview. The workspace ships a .asciidoctorconfig fragment (the asciidoctorconfig classifier of ike-build-standards) so the IDE preview matches the renderer the build uses — no per-machine attribute tweaking.

Finding the IKE goals

The ws: and ike: goals appear in the Maven tool window under Plugins → ws and Plugins → ike. Fully-qualified coordinates are not needed: ~/.m2/settings.xml carries the IKE pluginGroups (the scaffold maintains that entry), so mvn ws:overview resolves directly.

Per-machine settings are not synced

.idea/workspace.xml is intentionally excluded from sync, so a few IDE settings are one-time-per-machine — the Maven-home setting above is the important one. Project-level settings under .idea/ that are committed apply automatically.

macOS

Open .md and .adoc files in IntelliJ

By default macOS opens Markdown and AsciiDoc files in TextEdit, which shows raw markup. To get the rendered preview on double-click:

  • Select a .md (or .adoc) file in Finder
  • File → Get Info (⌘I)
  • Under Open with, choose IntelliJ IDEA
  • Click Change All… so the association applies to every file of that type

JDK and preview features

  • IKE projects build and run on JDK 25.
  • Projects that use Java preview features compile and run with --enable-preview. The build wires this in; if you run a class directly from the IDE, enable preview features in the run configuration.

Goal report files

Several ws: and ike: goals write a Markdown report next to the project root — for example ws꞉overview.md or ike꞉release-draft.md (the ꞉ is a Unicode modifier-colon, not a path separator). These files are gitignored scratch output (ike-issues#407): open them to read the rendered dependency graph, release plan, or foundation-drift report a goal just produced. They are regenerated on each run and are never committed.

Command line

(Planned — shell setup, the mvnw wrapper, and common goal invocations will be documented here.)

VS Code

(Planned — extension recommendations and AsciiDoc preview setup will be documented here.)

See also

  • ike-workspace-conventions.adoc — the rationale behind multi-machine, multi-branch IKE development.
  • IKE-Network/ike-issues[1] — the cross-project issue tracker.
Maven plugin workspace management release orchestration gitflow IKE Network knowledge engineering
Links:
  • [1] https://github.com/IKE-Network/ike-issues
Date: 2026-05-17 22:26:07 -0700
Searching...
No results.