Usage Guide

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: Learn about the programming languages, frameworks, and specifications that Noir can analyze.
• Configurations: Set up configuration files and shell completion for a better workflow.
• Output Formats: Discover the different output formats that Noir supports, including JSON, YAML, and OpenAPI.
• Passive Scanning: Learn how to use Noir's passive scanning feature to find potential security vulnerabilities in your code.
• GitHub Action: Integrate Noir into your CI/CD pipeline with the official GitHub Action.
• Additional Features: Explore advanced features like the Tagger and Deliver to streamline your workflow.
• 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.