# Security Analyser

## Package docs status

This page is generated from package source documentation in `the Capell packages repository` and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

| Field | Value |
| --- | --- |
| Composer package | `capell-app/security-analyser` |
| Package slug | `security-analyser` |
| Product group | Capell Essentials |
| Tier | free |
| Bundle | `foundation` |
| Capell version | `^1.0` |
| Catalogue role | extension |
| Release channel | Labs |
| Docs source | `packages/security-analyser/docs` |
| Manifest | `capell.json` |

<!-- prettier-ignore-start -->

Once a day, you can have Capell's security scan ask an AI model for a second opinion. The advice appears on the Security page marked as coming from the analyser. Each piece shows its severity, a short summary and any evidence the model cites. The built-in checks run whether or not you use it.

You choose the AI provider in AI Orchestrator. OpenAI, Anthropic and Gemini also need a key in the server's configuration, which a developer sets. Ollama needs none. A global administrator can also get advice at any time with the Run scan now button on the Security page. Each time, the model gets one request, listing the Capell version, the names of the built-in checks, and installed packages with versions, update settings and trusted and enabled status. It adds any known security advisories for them and a few on or off settings such as debug mode. Anything that looks like a password or key is left out first.

The model cannot see your code, live pages, account details or other settings, and Capell keeps only its advice on the kinds of problem the built-in scan already knows. It makes no changes, and an answer with nothing flagged does not mean the site is sound. What you get is advice to read beside the built-in findings.

- **Price and availability:** Check current availability and price on the [Capell Marketplace listing](https://capell.app/extensions/security-analyser).
- **Licence:** Published under MIT in `composer.json`.
- **Requires:** `PHP ^8.3`, `capell-app/core ^1.0.76`, `capell-app/ai-orchestrator ^1.0.1`.
- **Install:** `composer require capell-app/security-analyser`.

## Quick Start

1. Install the package: `composer require capell-app/security-analyser`.
2. Verify the package provider and manifest contributions are registered in the host app.

## For Developers

The prompt builder and review run live in typed Actions behind Core's analyser contract, so the model provider and prompt can change without touching the scan.

## Configure

- **Configuration files:** `config/capell-security-analyser.php`.

## Limits And Pitfalls

- Install the required Capell packages at the versions in `composer.json`: `capell-app/core ^1.0.76`, `capell-app/ai-orchestrator ^1.0.1`.

## Screens And Workflow

Docs gap: add `docs/screenshots.json` before promoting this package with visual workflow claims.

- Admin index screen if the package has a Filament resource.
- Create/edit screen if editors create records.
- Settings/configuration screen when settings exist.
- Frontend output when the package renders public pages.
- Package detail or install intent screen when marketplace-owned.

## Install Impact

- Required packages: `capell-app/core`, `capell-app/ai-orchestrator`.
- Admin navigation: no admin page or resource contribution is declared.
- Admin/editor extensions: none declared.
- Permissions: no package permission declarations or Shield gates detected; host access rules still apply.
- Public routes: none declared.
- Database changes: no package migrations declared.
- Config: `config/capell-security-analyser.php`.
- Settings: no package settings declared.
- Queues or schedules: none declared.
- Cache tags: none declared.
- Commands: none declared.

## Troubleshooting

| Symptom | Likely cause | Check | Fix |
| --- | --- | --- | --- |
| Package surface is missing after install | Provider or manifest is not loaded | Confirm `capell.json`, package `composer.json`, and provider registration | Reinstall the package, refresh Composer autoload, and clear host caches |

## Upgrading

No manual steps between minor versions.

Read [CHANGELOG.md](CHANGELOG.md) before upgrading.

## Next Steps

- [Package docs](README.md)
- [Overview](overview.md)
- Configuration files: [`config/capell-security-analyser.php`](config/capell-security-analyser.php).
- [Troubleshooting](#troubleshooting)
- [Developer reference](reference.md)
- [Capell content language plan](../../docs/CONTENT_LANGUAGE_PLAN.md)
- [Capell documentation design system](../../docs/DESIGN_SYSTEM.md)
- [Capell and package ERD notes](../../docs/erd/capell-and-package-erds.md)
- Related packages: [AI Orchestrator](../ai-orchestrator/README.md).

<!-- prettier-ignore-end -->