Terminal Integration

Run zero-knowledge security analysis directly from your local machine. Use Kedgr cloud mode for project-bound dashboard rulesets, or switch to offline mode to scan only the project on disk when the internet is unavailable.

Install via NPM
kedgr-terminal
$npm install -g @kedgr/cli
01

Global Installation

Install the package globally via npm to access the `kedgr` command anywhere.

$ npm install -g @kedgr/cli
02

Authentication

Login using your API key from `kedgr.solutions/settings`. Credentials are securely stored in `~/.kedgr/config.json`.

$ kedgr login --api-key <YOUR_KEY>
03

Bind Project + Rules

Choose the dashboard project whose attached rulesets should govern every terminal scan.

$ kedgr project list
04

Execute Scan

Package the workspace locally, then watch the backend phases progress from pending to scanning to completion.

$ kedgr scan .
05

Offline Local Run

If there is no internet, run local heuristics and secret detection directly on the current project without contacting the backend.

$ kedgr scan . --offline
06

CI/CD Pipeline Usage

In automated environments, avoid interactive login. Pass credentials directly and keep the selected project rulesets as the single source of truth.

# GitHub Actions Example
- name: Install Kedgr
  run: npm install -g @kedgr/cli
- name: Run Security Scan
  run: kedgr scan . --project-id ${{ secrets.KEDGR_PROJECT_ID }}
  env:
    KEDGR_API_KEY: ${{ secrets.KEDGR_API_KEY }}
07

Automatic Fallback

If cloud mode cannot reach `codechecker.pxxl.pro`, the CLI automatically falls back to an offline project-only scan so the developer can keep moving.

cloud scan unavailable
fallback: local project heuristics + secret detection