Periderm CLI

The easiest way to install Periderm CLI is using our installation script:

curl -fsSL https://periderm-cli.vercel.app//install.sh | bash

Alternative (NPM):

npm install -g periderm-cli

Verify Installation:

periderm --version

Prereqs: Node 18+.

Updating

To update Periderm CLI to the latest version, run the same installation command:

sudo npm install -g periderm-cli

The CLI will automatically notify you when a new update is available in the npm registry.

periderm scan requires a linked account. Run login once from any terminal:

periderm login

Your browser opens the dashboard CLI login page. After you approve the device, the CLI stores your token locally. Check the session anytime with periderm whoami.

From the project you want to check:

cd ~/path/to/your-project
periderm scan

You get a terminal verdict plus report files at:

.periderm/last-report.md
.periderm/last-report.json

To sync the scan to your dashboard (and get the in-app notification), upload it:

periderm scan

The CLI shows each file as it scans and counts deterministic checks as they run. Every finding explains why it matters. Open the uploaded scan in your dashboard for the full markdown report and AI review.

periderm scan

Scan the current directory, upload results to your Periderm dashboard, and write .periderm/last-report.md and .periderm/last-report.json. Requires login.

periderm scan --local-only

Scan locally without uploading to the dashboard. Useful for offline work or when you only need the terminal report.

periderm scan --cwd <dir>

Scan a directory other than the current working directory.

periderm review --deep

Scale/Unlimited. AI agent review for edge cases static checks miss. Appends to your last report.

periderm login

Link the CLI to your Periderm account via browser.

periderm logout

Clear the locally stored CLI token.

periderm whoami

Print API URL, user id, plan, and remaining scan quota.

periderm watch

Re-run scans on file change (no login required; no report files written).

When viewing scan reports in the dashboard, you may notice a string like 1c 5h · 5m · 2l. This breaks down findings by severity:

• c (Critical): Application-breaking bugs, severe security vulnerabilities, or runaway cloud costs.
• h (High): Data corruption risks or major UI/accessibility failures.
• m (Medium): Standard technical debt, missing error boundaries, or minor logic flaws.
• l (Low): Best practice warnings and optimization suggestions.

periderm review --deep runs an AI agent locally against your codebase after a scan. It is designed for nuanced edge cases that deterministic rules cannot enumerate upfront — legal copy mismatches, subtle UX traps, business-logic contradictions, and one-off launch risks.

Requirements:

• Scale or Unlimited plan (checked via your CLI token)
• A recent scan (.periderm/last-report.json)

periderm scan
periderm review --deep

Deep review adds findings; it does not replace the fast deterministic layer. Use both together before launch.

If you ever need to remove the CLI and its local configuration:

npm uninstall -g periderm-cli
rm -rf ~/.periderm