Getting started

Quickstart

Install the CLI, scan your projects, and read your first report in about five minutes. Nothing is uploaded.

1. Install

macOS / Linux (Homebrew)

$ brew install rburns629/tap/urfluency
$ urfluency doctor     # checks git and other tools it uses

2. Tell it who you are (optional)

urFluency finds your commits from your Git name and every address linked to it. init asks about addresses that only look like yours and saves the answers.

terminal

$ urfluency init ~/Projects
Is robert@old-employer.example yours? (412 commits in 9 repositories) [y/N]

3. Scan

terminal

$ urfluency scan --since all ~/Projects
$ urfluency scan --json --since all ~/Projects > report.json

tipThe summary prints last, where your terminal leaves it. Pipe to less to read from the top.

Common flags

--since all\|90d\|YYYY-MM-DD	How far back to read history. Default: 365d.
--json	Print the report as JSON instead of text.
--sessions	Read local agent transcripts for prompting and AI ratings. Counts only.
--locations	Include file and line for each finding. Local only, never uploaded.
--exclude <path>	Skip a folder, such as a vendored copy of someone else's code.
--include-ext .tf,.yml	Also read these extensions, for example to check them for secrets.
--author <email>	Add an address that is yours.

← How it works Get started →