Usage Guide
How to use Noir: supported technologies, output formats, AI integrations, and additional features.
Reference for running Noir and configuring its individual features.
Key Areas
- CLI Commands: The v1 subcommand reference (
scan,list,cache,config,rules,completion,version,help) with v0-compatibility notes. - Supported Technologies: The programming languages, frameworks, and specifications Noir can analyze.
- Configurations: Configuration files and shell completion.
- Output Formats: JSON, YAML, OpenAPI, and the other formats Noir can emit.
- Passive Scanning: Rule-based checks that flag potential security issues during a scan.
- GitHub Action: Run Noir in CI with the official GitHub Action.
- Additional Features: Tagger, Deliver, diff scanning, and the DAST pipeline.
- AI Power: How Noir's LLM integration works and when to enable it.
- AI Providers: Connect Noir to OpenAI, Ollama, and other providers for the LLM fallback path.