# Fossa

- [Introduction](https://fossa.mintlify.app/en/how_to_use/overview.md): What Fossa is, what Fossy the AI code reviewer does for your team, and where to go next.
- [Getting Started](https://fossa.mintlify.app/en/how_to_use/quickstart.md): Get Fossy reviewing your pull requests: create an account, connect your Git provider, pick repositories, and run a first review.
- [100% Free & Self-Hosted](https://fossa.mintlify.app/en/how_to_use/pricing.md): FOSSA is completely free, 100% open-source under AGPL-3.0, and self-hosted with no paid tiers, subscriptions, or selling.
- [BYOK - Bring Your Own Key](https://fossa.mintlify.app/en/how_to_use/byok.md): Connect your own provider keys, then choose which model runs each task. Available on every Fossa plan.
- [Monthly Spend Limit](https://fossa.mintlify.app/en/how_to_use/spend-limit.md): Get alerted as your BYOK model spend approaches a monthly cap. Alerts only — reviews keep running.
- [Code Review Flow](https://fossa.mintlify.app/en/how_to_use/code_review/flow.md): How a Fossy review runs end to end: when it triggers, when it skips, what you get back, and what each status emoji means.
- [Steer a Review (Focus)](https://fossa.mintlify.app/en/how_to_use/code_review/review_directive.md): Direct Fossy's attention to a specific area of a pull request with a one-off review directive, via PR comment or CLI
- [Review Policy](https://fossa.mintlify.app/en/how_to_use/code_review/policy.md): How to read Fossy's feedback and how it interacts with your merge policies — what blocks a PR, what doesn't, and who decides.
- [General](https://fossa.mintlify.app/en/how_to_use/code_review/configs/general.md): The core review settings — cadence, PR workflow, skip conditions, and analysis types — plus the full fossa-config.yml reference.
- [Centralized Config](https://fossa.mintlify.app/en/how_to_use/code_review/configs/centralized_config.md): Manage all code review configuration and Fossy Rules as code in a single repository. Changes sync automatically after each merge; rollout is controlled from the UI or the CLI.
- [Config Inheritance & Overrides](https://fossa.mintlify.app/en/how_to_use/code_review/configs/inheritance_overrides.md): How Global → Repository → Directory settings inherit, override, and propagate.
- [Directory-Level Settings](https://fossa.mintlify.app/en/how_to_use/code_review/configs/directory_level.md): Target specific folders in your repo with custom code review settings. Ideal for monorepos.
- [Review Filters](https://fossa.mintlify.app/en/how_to_use/code_review/configs/suggestion_control.md): Control how much feedback Fossy posts in your PRs.
- [PR Summarization](https://fossa.mintlify.app/en/how_to_use/code_review/configs/pr_summary.md): Have Fossy write concise, actionable pull request descriptions, and tune the tone, triggers, and behavior on existing descriptions.
- [Custom Messages](https://fossa.mintlify.app/en/how_to_use/code_review/configs/custom_messages.md): Configure personalized start and end review messages for Fossy
- [Custom Prompts](https://fossa.mintlify.app/en/how_to_use/code_review/configs/custom_prompts.md): Customize Fossy's review prompts for each category and how suggestions are written to match your team's needs
- [Linked Repositories](https://fossa.mintlify.app/en/how_to_use/code_review/configs/linked_repositories.md): Let Fossy read sibling repositories as context during review — for cross-repo contracts, and for code your repository depends on but doesn't contain.
- [Overview](https://fossa.mintlify.app/en/how_to_use/code_review/configs/fossy_rules.md): Fossy Rules are customizable guidelines your team sets up to automatically enforce code quality, consistency, security, and maintainability.
- [Rule Inheritance](https://fossa.mintlify.app/en/how_to_use/code_review/configs/rules_inheritance.md): How Global → Repository → Directory rules are inherited, and how to stop or exclude inheritance at specific levels.
- [Rules File Detection](https://fossa.mintlify.app/en/how_to_use/code_review/configs/rules_file_detection.md): Automatically detect and import your existing rule files from popular AI coding tools to enhance Fossy's code review capabilities with your team's established coding standards.
- [Repository Rules](https://fossa.mintlify.app/en/how_to_use/code_review/configs/repository_rules.md): Create custom Fossy Rules directly in your repository using markdown files with structured templates.
- [Global Rule Sources](https://fossa.mintlify.app/en/how_to_use/code_review/configs/global_rule_sources.md): Turn a connected repository into a source of organization-wide Fossy Rules, so a single set of architecture and coding standards applies across every repository during code review.
- [Automatic Rules Generation](https://fossa.mintlify.app/en/how_to_use/code_review/learning/fossy_rules_generation.md): Fossy can automatically generate custom rules by analyzing your team's code review history. Let her learn from your past reviews to create personalized coding standards.
- [Plugins](https://fossa.mintlify.app/en/how_to_use/code_review/plugins.md): Plugins are a way to bring external business context directly into Fossy's review workflow.
- [Business Logic Validation](https://fossa.mintlify.app/en/how_to_use/code_review/business_logic_validation.md): Compare your pull request against business rules or specs with @fossy -v business-logic.
- [Feedback on suggestions](https://fossa.mintlify.app/en/how_to_use/code_review/learning/fossy_learning.md): What feedback records today, and which mechanisms shape future reviews.
- [Fossa CLI](https://fossa.mintlify.app/en/how_to_use/cli/introduction.md): AI-powered code review, business validation, and agent workflows — from your terminal.
- [Getting Started](https://fossa.mintlify.app/en/how_to_use/cli/getting_started.md): Install the Fossa CLI, authenticate, and run your first review.
- [Concepts](https://fossa.mintlify.app/en/how_to_use/cli/concepts.md): Mental models to get the most out of the Fossa CLI.
- [Command Reference](https://fossa.mintlify.app/en/how_to_use/cli/commands.md): Complete reference for all Fossa CLI commands, flags, and options.
- [AI Agents](https://fossa.mintlify.app/en/how_to_use/cli/ai_agents.md): Integrate the Fossa CLI with AI coding agents for autonomous review-fix loops.
- [Self-Hosted Setup](https://fossa.mintlify.app/en/how_to_use/cli/self_hosted.md): Connect the Fossa CLI to your self-hosted Fossa instance.
- [Troubleshooting](https://fossa.mintlify.app/en/how_to_use/cli/troubleshooting.md): Common Fossa CLI errors, exit codes, and how to debug them.
- [Overview](https://fossa.mintlify.app/en/how_to_use/cockpit/overview.md): Comprehensive analytics and metrics for engineering team performance
- [Cockpit Configuration](https://fossa.mintlify.app/en/how_to_use/cockpit/configuration.md): Hide the Cockpit tabs and individual metrics your organization doesn't want to expose, from a single org-level setting.
- [Fossa Review](https://fossa.mintlify.app/en/how_to_use/cockpit/fossa_review.md): Measure how effective Fossa's reviews are — and act on it
- [Deploy Frequency](https://fossa.mintlify.app/en/how_to_use/cockpit/metrics/deploy_frequency.md): Measure how often your team deploys code to production
- [PR Cycle Time](https://fossa.mintlify.app/en/how_to_use/cockpit/metrics/lead_time_for_changes.md): Measure the time from first commit to production deployment
- [Bug Ratio](https://fossa.mintlify.app/en/how_to_use/cockpit/metrics/change_failure_rate.md): Measure the percentage of PRs that are bug fixes (also known as Change Failure Rate)
- [PR Size](https://fossa.mintlify.app/en/how_to_use/cockpit/metrics/pr_size.md): Measure the average size of your Pull Requests
- [Fossy Suggestions](https://fossa.mintlify.app/en/how_to_use/cockpit/metrics/fossy_suggestions.md): Measure the effectiveness of AI-powered code suggestions
- [Lead Time Breakdown](https://fossa.mintlify.app/en/how_to_use/cockpit/metrics/lead_time_breakdown.md): Break down your development cycle into coding, pickup, and review phases
- [Developer Activity](https://fossa.mintlify.app/en/how_to_use/cockpit/metrics/developer_activity.md): Track developer productivity and activity patterns over time
- [PRs by Developer](https://fossa.mintlify.app/en/how_to_use/cockpit/metrics/prs_by_developer.md): Track completed Pull Requests per developer grouped by week
- [PRs Opened vs Closed](https://fossa.mintlify.app/en/how_to_use/cockpit/metrics/prs_opened_vs_closed.md): Compare how many pull requests your team opens against how many it closes each week to spot a growing review backlog.
- [Overview](https://fossa.mintlify.app/en/how_to_use/issues/overview.md): Track and manage unimplemented suggestions with the Fossy Issues feature.
- [Workspace Roles](https://fossa.mintlify.app/en/how_to_use/workspace_roles.md): Learn about role-based access control (RBAC) in Fossa workspaces, including the different user roles and their permissions.
- [Single Sign-On](https://fossa.mintlify.app/en/how_to_use/security/sso.md): Enable Single Sign-On (SSO) for secure and efficient access to Fossa.
- [Github FGPAT Token](https://fossa.mintlify.app/en/how_to_use/code_review/general_config/github_pat.md): Generate the GitHub Fine-Grained PAT Fossy needs for code review, including how to unblock access to your organization's repositories.
- [GitLab PAT Token](https://fossa.mintlify.app/en/how_to_use/code_review/general_config/gitlab_pat.md): Generate the GitLab Personal Access Token Fossy needs to read your repositories and post review comments, with the exact scopes required.
- [Bitbucket API Token](https://fossa.mintlify.app/en/how_to_use/code_review/general_config/bitbucket_pat.md): Generate the Bitbucket Cloud API Token Fossy needs for code review, with the exact permissions to grant.
- [Azure DevOps PAT Token](https://fossa.mintlify.app/en/how_to_use/code_review/general_config/azure_devops_pat.md): Generate the Azure DevOps Personal Access Token Fossy needs to read your repositories and post review comments, with the exact scopes required.
- [Forgejo Access Token](https://fossa.mintlify.app/en/how_to_use/code_review/general_config/forgejo_pat.md): Generate the Forgejo access token Fossy needs to read your repositories and post review comments.
- [AI Model Security](https://fossa.mintlify.app/en/how_to_use/security/data_usage.md): Which AI models process your code, who holds the provider relationship, and what happens to your code during a review.
- [Troubleshooting](https://fossa.mintlify.app/en/how_to_use/code_review/troubleshooting.md): Troubleshooting Fossy Code Review
- [Fossa Architecture](https://fossa.mintlify.app/en/how_to_deploy/fossa_architecture.md): A deep dive into Fossa's technical infrastructure.
- [Local Quickstart](https://fossa.mintlify.app/en/how_to_deploy/local_quickstart/orchestrator.md): Get Fossa running on your local machine — API, Worker, Webhooks, Web UI, and all dependencies in one command.
- [Installation](https://fossa.mintlify.app/en/how_to_deploy/deploy_fossa/generic_vm.md): Deploy Fossa on a Generic Virtual Machine.
- [MCP Manager](https://fossa.mintlify.app/en/how_to_deploy/deploy_fossa/mcp_manager.md): Deploy MCP Manager for Fossa.
- [Sandbox & AST Graph](https://fossa.mintlify.app/en/how_to_deploy/deploy_fossa/sandbox.md): How Fossa parses your repo (fossa-graph), where it runs (sandbox modes), and when to pick each mode.
- [Analytics Worker](https://fossa.mintlify.app/en/how_to_deploy/deploy_fossa/analytics_worker.md): Optional analytics ingestion worker for self-hosted Fossa. Powers the Cockpit dashboards (DORA, lifecycle, classifier).
- [Reverse Proxy](https://fossa.mintlify.app/en/how_to_deploy/deploy_fossa/reverse_proxy.md): Configure a reverse proxy for Fossa.
- [Anonymous Telemetry](https://fossa.mintlify.app/en/how_to_deploy/deploy_fossa/telemetry.md): What the self-hosted heartbeat sends, why we collect it, and how to disable it.
- [Troubleshooting Guide](https://fossa.mintlify.app/en/how_to_deploy/deploy_fossa/troubleshooting.md): Solve common issues with Fossa.
- [Updating](https://fossa.mintlify.app/en/how_to_deploy/deploy_fossa/updating.md): Update your Fossa installation.
- [Kubernetes & OpenShift](https://fossa.mintlify.app/en/how_to_deploy/deploy_fossa/kubernetes.md): Deploy Fossa on Kubernetes or OpenShift with the official Helm charts.
- [Creating a GitHub App](https://fossa.mintlify.app/en/how_to_deploy/platforms/github/github_app.md): Create the GitHub App that lets Fossy read your repositories, comment on pull requests, and receive webhooks — with the exact permissions to grant.
- [GitHub OAuth App (Sign in with GitHub)](https://fossa.mintlify.app/en/how_to_deploy/platforms/github/github_oauth.md): Create the GitHub OAuth App that powers "Sign in with GitHub" for your Fossa users — separate from the GitHub App used for code review.
- [Creating a Webhook](https://fossa.mintlify.app/en/how_to_deploy/platforms/github/github_webhook.md): Manually create the GitHub webhook when automatic registration didn't happen, and select the three events Fossa consumes.
- [GitLab OAuth App (Sign in with GitLab)](https://fossa.mintlify.app/en/how_to_deploy/platforms/gitlab/gitlab_oauth.md): Create the GitLab OAuth App that powers "Sign in with GitLab" for your Fossa users — separate from the webhook integration used for code review.
- [Creating a Webhook](https://fossa.mintlify.app/en/how_to_deploy/platforms/gitlab/gitlab_webhook.md): Manually create the GitLab webhook when automatic registration didn't happen, and select the events Fossa consumes.
- [Creating a Webhook](https://fossa.mintlify.app/en/how_to_deploy/platforms/bitbucket/bitbucket_webhook.md): Manually create the Bitbucket webhook when automatic registration didn't happen, and pick the pull request triggers Fossa actually consumes.
- [Creating a Webhook](https://fossa.mintlify.app/en/how_to_deploy/platforms/azure_devops/azdevops_webhook.md): Manually register the Azure Repos webhook when Fossy couldn't create the service hook for you, including the signed token the URL requires.
- [Creating a Webhook](https://fossa.mintlify.app/en/how_to_deploy/platforms/forgejo/forgejo_webhook.md): Manually create the Forgejo webhook when automatic registration didn't happen, and select the events Fossa consumes.
- [Knowledge Base](https://fossa.mintlify.app/en/knowledge_base/introduction.md): Answers to common questions about AI code review, coding standards enforcement, business logic validation, and more.
- [How to enforce coding standards in pull requests](https://fossa.mintlify.app/en/knowledge_base/how-to-enforce-coding-standards-in-pull-requests.md): Learn how to automatically enforce your team's coding conventions, architecture rules, and best practices on every pull request.
- [How to automate code review on GitHub, GitLab, and Bitbucket](https://fossa.mintlify.app/en/knowledge_base/how-to-automate-code-review.md): Set up AI-powered code review that runs automatically on every pull request across GitHub, GitLab, Bitbucket, and Azure DevOps.
- [How to create custom code review rules](https://fossa.mintlify.app/en/knowledge_base/how-to-create-custom-code-review-rules.md): Define rules tailored to your team's architecture, patterns, and coding preferences that are enforced automatically on every PR.
- [How to reduce code review noise and false positives](https://fossa.mintlify.app/en/knowledge_base/how-to-reduce-code-review-noise.md): Fine-tune your AI code review to surface only the most relevant suggestions and avoid alert fatigue.
- [What is the difference between Review Rules and Memories](https://fossa.mintlify.app/en/knowledge_base/difference-between-review-rules-and-memories.md): Understand when to use Review Rules vs Memories in Fossy for the best code review results.
- [How to teach AI your team's coding conventions](https://fossa.mintlify.app/en/knowledge_base/how-to-teach-ai-your-team-conventions.md): Use Memories to make Fossy learn your coding preferences, architectural decisions, and team conventions through natural conversation.
- [How to validate if a PR implements a Jira ticket](https://fossa.mintlify.app/en/knowledge_base/how-to-validate-pr-against-jira-ticket.md): Use Fossa to compare your pull request against Jira acceptance criteria and catch missing requirements before merging.
- [How to validate Linear issues against pull requests](https://fossa.mintlify.app/en/knowledge_base/how-to-validate-pr-against-linear-issue.md): Ensure your pull request implements what the Linear issue describes by using AI-powered business logic validation.
- [How to check code against Google Docs specs](https://fossa.mintlify.app/en/knowledge_base/how-to-check-code-against-google-docs.md): Validate your pull request implementation against specifications written in Google Docs.
- [How to validate business rules before merging](https://fossa.mintlify.app/en/knowledge_base/how-to-validate-business-rules-before-merging.md): Catch missing requirements, forgotten edge cases, and logic gaps in your pull request before code reaches production.
- [How to import rules from Cursor, Copilot, or Claude](https://fossa.mintlify.app/en/knowledge_base/how-to-import-rules-from-ide-tools.md): Sync your existing AI coding tool rules into Fossa so the same standards apply in your IDE and in code review.
- [How to generate code review rules automatically](https://fossa.mintlify.app/en/knowledge_base/how-to-generate-rules-automatically.md): Let AI analyze your code review history and suggest custom rules based on your team's actual patterns and standards.
- [How to share coding standards across repositories](https://fossa.mintlify.app/en/knowledge_base/how-to-share-standards-across-repositories.md): Use rule inheritance and organization-level rules to maintain consistent coding standards across all your repositories.
- [How to review PRs with project-specific context](https://fossa.mintlify.app/en/knowledge_base/how-to-review-prs-with-project-context.md): Give Fossy access to your project docs, handbooks, and architecture guides for more relevant code reviews.
- [How to use linked repositories for cross-repo context in code review](https://fossa.mintlify.app/en/knowledge_base/how-to-use-linked-repositories-in-code-review.md): Link sibling repositories so Fossy can read contracts and APIs across services when a PR touches a boundary surface.
- [How to set up AI code review on GitHub](https://fossa.mintlify.app/en/knowledge_base/how-to-set-up-ai-code-review-on-github.md): Install and configure Fossa for GitHub repositories to get automated AI code review on every pull request.
- [How to set up AI code review on GitLab](https://fossa.mintlify.app/en/knowledge_base/how-to-set-up-ai-code-review-on-gitlab.md): Install and configure Fossa for GitLab projects to get automated AI code review on every merge request.
- [How to set up AI code review on Azure DevOps](https://fossa.mintlify.app/en/knowledge_base/how-to-set-up-ai-code-review-on-azure-devops.md): Install and configure Fossa for Azure DevOps repositories to get automated AI code review on every pull request.
- [How to connect Jira to your code review tool](https://fossa.mintlify.app/en/knowledge_base/how-to-connect-jira-to-code-review.md): Link Jira to Fossa so your AI code reviews automatically validate PRs against task requirements and acceptance criteria.
- [How to connect Linear to your code review tool](https://fossa.mintlify.app/en/knowledge_base/how-to-connect-linear-to-code-review.md): Link Linear to Fossa so your AI code reviews automatically validate PRs against issue requirements.
- [Can I use my own LLM provider for code review](https://fossa.mintlify.app/en/knowledge_base/can-i-use-my-own-llm-provider.md): Bring your own API key and choose your preferred LLM provider for AI-powered code review with Fossa.
- [How to self-host an AI code review tool](https://fossa.mintlify.app/en/knowledge_base/how-to-self-host-ai-code-review.md): Deploy Fossa on your own infrastructure with full control over data, models, and configuration.
- [Why is my AI code review not triggering](https://fossa.mintlify.app/en/knowledge_base/why-is-ai-code-review-not-triggering.md): Common reasons and fixes when Fossa doesn't automatically review your pull requests.
- [How to fix webhook issues with GitHub or GitLab](https://fossa.mintlify.app/en/knowledge_base/how-to-fix-webhook-issues.md): Debug and resolve webhook connectivity problems between your Git provider and Fossa.
- [Why are my code reviews paused](https://fossa.mintlify.app/en/knowledge_base/why-are-code-reviews-paused.md): Understand Fossa auto-pause behavior and how to resume automated code reviews.
- [Z.AI (GLM Coding Plan) - Subscription-Based Inference](https://fossa.mintlify.app/en/knowledge_base/how-to-use-z-ai-with-fossa.md): Learn how to connect Z.AI's GLM models — including the GLM Coding Plan subscription — to Fossa.
- [Synthetic — Flat-Rate Subscription for Open-Source Coding Models](https://fossa.mintlify.app/en/knowledge_base/how-to-use-synthetic-with-fossa.md): Learn how to connect Synthetic.new's subscription-based API — bundling Kimi, DeepSeek, Qwen Coder, GLM and more — to Fossa.
- [Chutes — Subscription-Capped Inference for Open-Source Models](https://fossa.mintlify.app/en/knowledge_base/how-to-use-chutes-with-fossa.md): Learn how to connect Chutes AI's subscription plans — covering DeepSeek, Llama, Qwen, MiniMax and more — to Fossa.
- [Moonshot (Kimi) - OpenAI-Compatible Inference](https://fossa.mintlify.app/en/knowledge_base/how-to-use-moonshot-with-fossa.md): Learn how to connect Moonshot AI's Kimi K2.6 models to Fossa — via the Moonshot Developer API or the Kimi Code Plan.
- [Novita AI - Serverless GPU Platform](https://fossa.mintlify.app/en/knowledge_base/how-to-use-novita-with-fossa.md): Learn how to use Novita's models with Fossa
- [Groq Cloud - Ultra-Fast Inference](https://fossa.mintlify.app/en/knowledge_base/how-to-use-groq-with-fossa.md): Learn how to use Groq's models with Fossa
- [Together AI - Open Source Models](https://fossa.mintlify.app/en/knowledge_base/how-to-use-together-ai-with-fossa.md): Learn how to use Together AI's models with Fossa
- [Fireworks AI - Fast Inference Platform](https://fossa.mintlify.app/en/knowledge_base/how-to-use-fireworks-with-fossa.md): Learn how to use Fireworks AI's models with Fossa
- [Install custom MCP plugins](https://fossa.mintlify.app/en/cookbook/custom-plugin-install.md): Step-by-step instructions for connecting any custom Model Context Protocol plugin to Fossa.
- [Turn your best practices doc into review guardrails](https://fossa.mintlify.app/en/cookbook/guide-handbook-guardrails.md): Convert your engineering handbook into living Fossy Rules with optional MCP plugins.
- [Fossa for monorepos](https://fossa.mintlify.app/en/cookbook/fossa-for-monorepos.md): Configure directory-level rules, path-specific overrides, and rule inheritance to get precise code reviews in a monorepo.
- [Security-first review pipeline](https://fossa.mintlify.app/en/cookbook/security-first-review-pipeline.md): Set up Fossy Rules focused on OWASP top 10, secrets detection, and secure coding patterns.
- [Fossa + sprint workflow](https://fossa.mintlify.app/en/cookbook/fossa-sprint-workflow.md): Integrate business logic validation into your sprint cycle so every PR is validated against task requirements before merge.
- [Onboarding a new team](https://fossa.mintlify.app/en/cookbook/team-onboarding.md): Step-by-step guide to set up Fossa for a new team — from connecting repos to teaching your first conventions.
- [PR review for compliance (SOC2, HIPAA)](https://fossa.mintlify.app/en/cookbook/compliance-review-pipeline.md): Configure Fossy Rules and Memories to enforce audit trail, data handling, and access control requirements.
- [Novita AI - Serverless GPU Platform](https://fossa.mintlify.app/en/cookbook/novita.md): Learn how to use Novita's models with Fossa
- [Fireworks AI - Fast Inference Platform](https://fossa.mintlify.app/en/cookbook/fireworks.md): Learn how to use Fireworks AI's models with Fossa
- [Together AI - Open Source Models](https://fossa.mintlify.app/en/cookbook/together.md): Learn how to use Together AI's models with Fossa
- [Groq Cloud - Ultra-Fast Inference](https://fossa.mintlify.app/en/cookbook/groq.md): Learn how to use Groq's models with Fossa
- [Changelog](https://fossa.mintlify.app/changelog/index.md): Latest Fossa updates and improvements.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.