<p>There are some great resources about how to get started using IntelliJ. As opposed to trying to repeat them here, we advise
you to go to the <aclass="reference external"href="https://www.jetbrains.com/idea/documentation/">IntelliJ docs here</a>.</p>
</div>
<divclass="section"id="command-line">
<h2>Command Line<aclass="headerlink"href="#command-line"title="Permalink to this headline">¶</a></h2>
<divclass="section"id="windows-vs-mac-unix">
<h3>Windows vs Mac / Unix<aclass="headerlink"href="#windows-vs-mac-unix"title="Permalink to this headline">¶</a></h3>
<p>Due to the nature of their respective command interfaces, gradle is typically ran in windows with the command <codeclass="docutils literal"><spanclass="pre">gradle.bat</span></code>
(or <codeclass="docutils literal"><spanclass="pre">gradlew.bat</span></code> if using the wrapper) and in Mac / Unix environments it is ran via <codeclass="docutils literal"><spanclass="pre">./gradlew</span></code>. For brevity, the
simple windows syntax <codeclass="docutils literal"><spanclass="pre">gradle</span></code> is used for the majority of the documentation.</p>
<p>As well as including the most significant run and build configurations in the IDE, we also provide gradle tasks to build, install
and run significant parts of Corda demos and tools. Gradle is highly extensible and we use it for downloading required resources,
building components, installing those built components into shared areas, configuring the scripts that run nodes, starting
up demonstration API calls amongst other things. It is exceptionally good at deriving dependency maps and therefore performing
a <codeclass="docutils literal"><spanclass="pre">gradle</span><spanclass="pre">clean</span></code> may be required in order to clear out any build areas that have an inconsistent state. The total build time
<p>Note that the list of tasks can be ran for any gradle project can be displayed by running the task <codeclass="docutils literal"><spanclass="pre">tasks</span></code>. Also, note that
gradle is hierarchical and therefore tasks in child directories can be run using a colon separator. For example, if you want to run
the sample attachment demo run configuration <codeclass="docutils literal"><spanclass="pre">runSender</span></code>, you would use the command <codeclass="docutils literal"><spanclass="pre">gradle</span><spanclass="pre">samples:attachment-demo:runSender</span></code></p>
<p>The most frequent gradle tasks you will probably be running are <codeclass="docutils literal"><spanclass="pre">build</span></code> and <codeclass="docutils literal"><spanclass="pre">install</span></code>. The <codeclass="docutils literal"><spanclass="pre">build</span></code> command also executes the
unit tests as well. If you want to build without this level of verification, then use the <codeclass="docutils literal"><spanclass="pre">assemble</span></code> command - but we do
not recommend this. After running build, the <codeclass="docutils literal"><spanclass="pre">install</span></code> tasks copies over the built jars into the local maven repository
<h2>Debugging<aclass="headerlink"href="#debugging"title="Permalink to this headline">¶</a></h2>
<p>Tasks and processes that are run directly via the IDE (including via the usage of the <codeclass="docutils literal"><spanclass="pre">driver</span></code> DSL) can be remotely debugged.
We do not have java debugging currently enabled in the <codeclass="docutils literal"><spanclass="pre">runnodes</span></code> scripts generated by a process we refer to as ‘cordformation’
but we will be implementing that shortly.</p>
<divclass="section"id="via-the-ide">
<h3>Via the IDE<aclass="headerlink"href="#via-the-ide"title="Permalink to this headline">¶</a></h3>
<p>To debug: From the IDE, configure the debug connectivity option by the “Edit Configurations” and choosing “+” and then “Remote”.
The debug port start at 5005 and increments for each additional node that starts, the order given by the list in the main
driver configuration (which is primarily listed in the <codeclass="docutils literal"><spanclass="pre">main</span></code> function of <codeclass="docutils literal"><spanclass="pre">Main.kt</span></code> for each sample. Look for the string
<codeclass="docutils literal"><spanclass="pre">Listening</span><spanclass="pre">for</span><spanclass="pre">transport</span><spanclass="pre">dt_socket</span><spanclass="pre">at</span><spanclass="pre">address:5xxx</span></code> in the log output to determine the exact port for that node. If the log
messages are mixed from several nodes to the same console, then (as earlier stated), the port numbers increment in the order
they are listed in the driver DSL configuration.</p>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
