Getting started with the Guardian CLI

Guardian examines a mobile project in your environment and writes its findings locally. This page covers what you need before the first scan and how to confirm the CLI is working. Thefirst scan walkthrough is the next page.

Requirements

A supported mobile projectFlutter, native iOS or native Android, checked out on this machine.
The Guardian CLIAlready installed and on your PATH. System requirements for the macOS application are published with its first verified release.
No network connectionThe scan command’s own help states that scans never use the network.
No account, and no credentialsA local scan involves neither. Guardian should never ask you for signing keys or production database access.

Confirm the CLI

If you already have Guardian, this is the whole verification. A version string means the binary is installed and reachable from this shell.

Terminal

guardian version

If the shell reports that the command was not found, that is a PATH problem rather than a Guardian problem —troubleshooting covers it.

Check the environment

This inspects the local Guardian environment. Missing platform tooling shows up here first, and it is the reason a later scan reports incomplete coverage rather than a clean pass.

Terminal

guardian doctor

Next steps

Run your first scan — detection through to a report, in four commands.
Ways to access Guardian — if you are deciding how your team should run it.
Checks catalogue — what is actually checked, with each item’s status.

Run your first scan