Getting started

Install Ironwood and run your first review.

Start the self-hosted package, create the first Admin, connect the services your review needs, then run Ironwood against your own code.

Keep this guide handy

You can return to Documentation → Getting started at any time. The evaluation setup page is temporary; this guide stays available.

Jump to configuration
Before you start

You need Docker Desktop running, access to a GitHub or Azure DevOps repository, and credentials for the AI provider or providers you want to use. Windows and macOS are supported, including Apple Silicon and Intel Macs.

1. Download the evaluation

After verifying your work email, download the current evaluation package and copy the evaluation code shown on the setup page. If you return later, use Continue evaluation to receive a fresh magic link and get back to the latest download.

2. Start Ironwood

Extract the package first, then run the command for your operating system.

Windows · PowerShell.\START-EVALUATION.cmd
macOS · Terminalbash ./START-EVALUATION.sh
Windows users: use PowerShell

Open PowerShell in the extracted Ironwood folder and run the command above. Do not double-click START-EVALUATION.cmd.

Reinstall or refresh

Reinstall Ironwood without reinstalling Docker

If you need to install Ironwood again, stop the existing Ironwood installation first. You do not need to uninstall Docker Desktop.

Windows · PowerShell.\STOP-EVALUATION.cmd
macOS · Terminalbash ./STOP-EVALUATION.sh

For a completely clean reinstall, run docker compose --env-file .env down -v --remove-orphans from the old Ironwood folder. This removes Ironwood's local settings and review history.

Need a fresh evaluation code?

Use Continue evaluation on the Ironwood Solutions website with the same email address. The magic link returns you to the latest download and provides a fresh activation code. Reinstalling does not restart the 30-day evaluation.

First sign-in

3. Create the first Admin and sign in

When the services are running, open http://localhost:3002. On a fresh installation, Ironwood asks you to create the first Admin account. Create the account, then sign in with those credentials.

Ironwood Create First Admin User screen
Create the first Admin account on a fresh installation.
Ironwood login screen
Sign in with the Admin account you just created.
Configuration

4. Configure Source Control

Open Settings → Source Control and configure GitHub or Azure DevOps. Test the connection, enable it and save. Ironwood uses this connection to load the repositories, branches and commits available for review.

Ironwood Source Control settings
Source Control: configure, test, enable and save the source-control integration used for reviews.
Configuration

5. Configure AI Providers and Consensus

Open Settings → AI Providers. Configure and test the providers you want Ironwood to use. You can review with one provider or configure several and use Multi-Model Consensus to compare their findings.

Ironwood AI Provider settings
AI Providers: configure and test the provider credentials available to Ironwood.
Ironwood Multi-Model Consensus settings
Consensus: choose the participating providers and agreement settings, then enable Consensus for reviews.
Configuration

6. Set review behaviour and delivery integrations

Use Settings → Review Behaviour to choose how Ironwood publishes findings and to configure the engineering-cost assumptions used for estimated review time, savings and ROI. Configure Delivery Integrations if you want to create Jira or Azure Boards work items or publish review output to Confluence. You can skip delivery integrations for your first review.

Ironwood Review Behaviour settings with cost comparison assumptions
Review Behaviour: choose the publication behaviour and configure the assumptions used for estimated review impact and ROI.
Ironwood Delivery Integrations settings
Delivery Integrations: connect Jira, Azure Boards or Confluence when your workflow needs them.
Engineering knowledge

7. Add your engineering knowledge

If you want Ironwood to use your team's standards, architecture guidance or other supporting documents, configure an embeddings provider and add the documents under Engineering Knowledge. Check that the content is indexed before using it in a review.

Ironwood Embeddings settings
Embeddings: configure the provider used to index and retrieve engineering knowledge.
Ironwood Engineering Knowledge document upload
Engineering Knowledge: upload the documents you want Ironwood to use as review context.
Ironwood RAG status
RAG status: confirm that the supporting content is indexed and ready for retrieval.
Ready check

8. Check Platform Health

Before the first review, open Platform Health. Check that the services and integrations your review depends on are healthy. Fix anything that is not ready before continuing.

Ironwood Platform Health
Platform Health: check the services and integrations required by the review workflow.
First review

9. Select the repository

Open Run Review and choose a repository from the active source-control integration.

Run Review repository selection
Select the repository you want Ironwood to review.

10. Select the branch

Choose the branch that contains the change you want to review.

Run Review branch selection
Select the branch, then continue to review scope.

11. Select a commit or run a full repository scan

Select the commit you want reviewed, or choose Full repo scan when you want Ironwood to inspect the repository more broadly.

Run Review commit or full repository scan selection
Choose a commit or Full repo scan.

12. Add requirement context

Select the requirement source and the requirements that apply to this review. Ironwood adds that context to its engineering checks rather than treating the requirement as the entire review standard.

Run Review requirement selection
Choose the requirements that should be considered during the review.

13. Select supporting engineering knowledge

If you have indexed engineering knowledge, select the documents relevant to this review. Ironwood retrieves this material to bring your team's own standards and architecture context into the review.

Run Review supporting engineering knowledge selection
Select the indexed engineering knowledge that applies to the review.

14. Run the review

Confirm the selected scope and context, then select Run Review. Ironwood runs the configured provider or Consensus workflow and stores the completed result in Review History.

Run Review final confirmation screen
Confirm the review scope and context, then start the review.
Understand the result and take action

15. Open Review History

When the review finishes, open Review History. You can browse completed reviews and reopen any result you need to inspect.

Ironwood Review History
Review History: browse completed reviews and reopen the result you want to inspect.

16. Review the completed result

Open the completed review to inspect the final findings, provider execution detail and Consensus evidence. Individual provider candidates remain available even when they were not automatically published. A reviewer can promote a provider candidate into the final findings when it should be included.

From the same review, use the actions available to your role and configured integrations. You can download the report, create a Jira or Azure Boards work item, or publish the review output to Confluence.

Completed Ironwood review with Consensus, provider findings and delivery actions
Completed review: inspect Consensus and provider evidence, promote a provider finding when needed, then download or deliver the reviewed result.
Engineering impact

17. Check AI Insights

Open AI Insights to see estimated engineering impact across completed reviews. Ironwood uses the Review Behaviour assumptions together with captured review usage to show estimated manual review time and cost, Ironwood review cost, estimated savings and ROI. These values are estimates for engineering planning and comparison, not provider invoice data.

Ironwood AI Insights engineering impact and ROI dashboard
AI Insights: review estimated engineering time and cost impact, provider cost, Ironwood cost, savings and ROI across completed reviews.
30-day evaluation2 developers1 active installationFull Professional featuresUnlimited repositories and reviews