@code-sentinel-cli/code-sentinel-cli

AI-assisted code review CLI for Angular, Spring Boot, and Flutter projects.

Install

npm install -g @code-sentinel-cli/code-sentinel-cli
cs --help

Requires Node.js 22 or newer.

Quick Start

cs quickstart
cs init
cs review . --ai-off

Enable AI review by configuring a provider key in your shell or local Code Sentinel config, then run:

cs review .

Common Commands

• cs --help - list commands.
• cs version --json - print machine-readable build metadata.
• cs doctor - check local prerequisites.
• cs init - create a local .code-sentinel/codereviewrc.yaml.
• cs review . - run a review for the current workspace.
• cs rule list - inspect bundled rules.

Configuration

Secrets such as AI provider keys and dashboard tokens are read from local config or environment variables at runtime; they are not bundled into this npm package. Useful environment variables include:

• LLM_API_KEY, GEMINI_API_KEY, GROQ_API_KEY, OPENCODE_GO_API_KEY, CUSTOM_AI_API_KEY - optional custom OpenAI-compatible provider credentials.
• CODE_SENTINEL_DASHBOARD_URL and CODE_SENTINEL_DASHBOARD_TOKEN - dashboard integration.
• CODE_SENTINEL_NO_UPDATE_CHECK=1 - disable npm update checks.
• NO_COLOR=1 - disable ANSI color output.

Updates

The CLI may check npm for a newer package version at most once every 24 hours when running in an interactive terminal. It skips CI/non-TTY sessions, does not block review execution on network errors, and can be disabled with CODE_SENTINEL_NO_UPDATE_CHECK=1 or NO_UPDATE_NOTIFIER=1.

npm install -g @code-sentinel-cli/code-sentinel-cli@latest

Troubleshooting

• Use Node.js 22 or newer: node --version.
• Run cs doctor for local setup checks.
• Run with --no-color if your terminal does not support ANSI colors.
• Use cs review . --ai-off for an offline static-rule-only smoke test.

Module Format

This package is ESM-only. The supported public import surface is the package root export; deep imports from dist/ are not part of the compatibility contract.