Helix Swarm Guide

This guide tells you how to use Helix Swarm for collaboration and code review for teams using Helix Core Server. It is intended for anyone using Swarm to perform code review tasks with Helix Server.

See these topics to get started:

New for Swarm 2022.1.4

Following is a summary of new information with links to the most prominent topics. For a complete list, see What's new.

New Swarm review page (preview)

The new Swarm review page introduces some of our most requested features such as syntax highlighting, a new Information panel, a file list, improved markdown support, and more! In essence, the page is completely re-written, so there are many improvements for you to discover. See Review display.

To access the review page preview, use the Preview toggle at the top of the review page. In this way, you can freely switch between the original review page and the new one. The new review page will replace the original page in a later release. The new page is currently missing a few features that will be added in a later release, see Review page (preview) for details. Please share your feedback with us if there is anything you miss from the original review page. For contact details, see Getting help

Help for the original Swarm review page is available in the Swarm 2021.2 documentation, see Review display.

Review Display Page image

Image diff display on the review page (preview)

Swarm now displays images that are natively supported by your browser in the review page diff panel (preview). Use the vertical slider on the image to view the changes made to the image. See File diff panel.

Support for Amazon Linux 2

You can now install Swarm on Amazon Linux 2 using a package, see Install and configure Swarm on Amazon Linux 2.

Swarm support for Helix Core Server Extensions

You can now use Helix Core Server Extensions instead of triggers to enable Swarm to get event notifications from your Helix Core Server. See Helix Core Server Extensions dependencies.

API version updated to v11 for this release

For Swarm 2022.1, we have introduced a new set of v11 APIs. These refine and extend the v10 APIs, and further standardize the endpoint and response pattern. The v10 APIs will continue to be available for some time to come

  • Any improvements made in the migration to v11 will not be backported to v9 or v10.
  • New API endpoints will be created as v11 and will not be backported to v9 or v10.

API version support changing

Support for APIs older than v9 will be removed in the Swarm 2022.2 release.

PHP support changed for Swarm 2022.1

We have removed support for PHP 7.0 and 7.1 for Swarm 2022.1. This is part of our commitment to move away from using versions of platforms that have reached End-of-Life (EOL).

Microsoft Internet Explorer support removed for Swarm 2022.1

We have removed support for Microsoft Internet Explorer for Swarm 2022.1. This is part of our commitment to move away from using platforms that have reached End-of-Life (EOL).

Swarm no longer supports CentOS 8

Swarm 2022.1 does not support Swarm installation on CentOS 8. This is part of our commitment to move away from using versions of platforms that have reached End-of-Life (EOL).

Additional help

Helix Core Command-Line (P4) Guide

See the Helix Core Command-Line (P4) Guide for concepts and procedures for the command line client.

Helix Core Command-Line (P4) Reference

See p4 client (graph) in the Helix Core Command-Line (P4) Reference for help configuring Helix Server for building from mixed clients.

Helix Core Server Administrator Guide

See Helix Core Server Administrator Guide for information on installation, configuration, and management of Helix Server.

Helix Swarm Guide

For earlier versions of the Helix Swarm Guide.