Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.binarly.io/llms.txt

Use this file to discover all available pages before exploring further.

Rule Playground allows users to develop rules interactively, test them against images uploaded to the Binarly Transparency Platform, and see the results in real-time. This feature is especially useful for users who want to quickly prototype and validate their rules before deploying them in a production environment.

​
Accessing Rule Playground

Each user has access to their own Rule Playground environment. To access it, navigate to “Rules -> Playground” in the navigation menu.

​
Editor Interface

The Rule Playground interface consists of three main sections:
  • File Explorer: Located on the left side, this section allows users to navigate between different Rulesets and their associated rules.
  • Code Editor: The central section where users can write and edit their rules. It supports syntax highlighting and linting for better code readability and error detection.
  • Test Images and Results: On the right side, users can select test images or upload a new ones to test their rules and view the results of the rule execution.

​
Scanning Images

Scan can be initiated if the following conditions are met:
  • A rule is not empty and has no syntax errors.
  • At least one test image is selected or uploaded.
To scan images click the “Scan” button located at the top right of the interface. The system will execute the rule against the selected images and display the results in the “Results” tab. Results of scanning test images include the following evidence and code snippets to aid debugging rules.
  • Components matched by the rule.
  • Build environment details.
  • Code listing showing where the match occurred.
  • Hex dump of the matched data.
Note: a user can only select the images they have access to, based on their permissions.