forkless/strix
1
0
Fork 0
mirror of https://github.com/usestrix/strix.git synced 2026-08-18 17:52:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Reduce OSS docs diff to STE fixes

Browse Source
This commit is contained in:
Alex Schapiro
2026-08-14 19:32:17 +00:00
parent 5e8a773f3e
commit cb3fa2db51
10 changed files with 50 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/integrations/coding-agents.mdx
+9 -24
View File
@@ -7,7 +7,7 @@ Strix is built to be driven by AI coding agents. Install the official agent skil
## Install the Skills
These skills work with agents that support the open [SKILL.md standard](https://agentskills.io), including Claude Code, Cursor, Codex, Gemini CLI, and OpenCode:
Works with any agent that supports the open [SKILL.md standard](https://agentskills.io), including Claude Code, Cursor, Codex, Gemini CLI, OpenCode, and dozens more:
```bash
npx skills add usestrix/strix
@@ -15,8 +15,8 @@ npx skills add usestrix/strix
| Skill | What your agent learns |
|-------|------------------------|
| `penetration-testing-with-strix` | Run headless scans against code, URLs, domains, or IP addresses with the self-hosted CLI or the managed cloud, apply budget caps, and read the results |
| `managed-pentesting-with-strix` | Use the managed [app.strix.ai](https://app.strix.ai) platform through REST without local Docker or an LLM key |
| `penetration-testing-with-strix` | Run headless scans against code, URLs, domains, or IPs: self-hosted CLI or managed cloud: with budget caps, and read the results |
| `managed-pentesting-with-strix` | Drive the managed [app.strix.ai](https://app.strix.ai) platform over REST: no local Docker or LLM key needed |
| `fix-security-vulnerabilities-with-strix` | Triage findings, fix root causes, and re-run Strix to verify each fix |
| `ci-security-scanning-with-strix` | Add PR security scanning to GitHub Actions or any CI (self-hosted CLI or managed app) |
@@ -26,12 +26,12 @@ Install a single skill with `npx skills add usestrix/strix --skill penetration-t
npx skills use usestrix/strix@penetration-testing-with-strix | claude
```
## Two Ways to Run Strix
## Two ways to run: self-hosted or managed
Both options provide machine-readable results. Choose the option that fits your environment.
Both use the same engine and produce the same validated findings and SARIF. Agents can pick per situation or combine them.
- **Open-source CLI (self-hosted):** Runs locally in a Docker sandbox with your LLM key. This option is free, local, and air-gap capable.
- **Managed cloud:** Runs on Strix infrastructure through the [app.strix.ai REST API](https://docs.app.strix.ai). This option needs no Docker, LLM key, or local installation. The Enterprise plan adds dashboards, scheduling, pull request reviews, and PDF or DOCX reports.
- **Open-source CLI (self-hosted):** Runs locally in a Docker sandbox with your LLM key. It is free, fully local, and air-gap capable. It suits local development loops and full control.
- **Managed cloud:** Runs on Strix infrastructure through the [app.strix.ai REST API](https://docs.app.strix.ai). It needs no Docker, LLM key, or local installation. The Enterprise plan adds dashboards, scheduling, pull request reviews, and PDF or DOCX reports. It suits sandboxed or CI environments and teams.
Create a managed API token under **Settings > API Access**. The `managed-pentesting-with-strix` skill documents the full flow.
@@ -40,23 +40,8 @@ Create a managed API token under **Settings > API Access**. The `managed-pentest
Everything an agent needs is machine-readable:
- **Headless CLI:** `strix -n` runs without the TUI. It exits with `0` for a clean scan, `1` for an error, or `2` for vulnerabilities.
- **REST API:** The managed platform exposes a documented [OpenAPI](https://docs.app.strix.ai/openapi.json) at `https://app.strix.ai/api/v1`.
The API supports:
- scans
- vulnerabilities
- assets
- pull request reviews
- schedules
- webhooks
The API uses bearer tokens and scopes.
- **Structured results:** Each self-hosted run writes these files under `strix_runs/<run-name>/`:
- `vulnerabilities.json`
- `vulnerabilities.csv`
- `findings.sarif` in SARIF 2.1.0 format
- Per-finding Markdown files
The cloud exposes the same data as JSON and provides SARIF export.
- **REST API:** The managed platform exposes a documented [OpenAPI](https://docs.app.strix.ai/openapi.json) at `https://app.strix.ai/api/v1`. It supports scans, vulnerabilities, assets, pull request reviews, schedules, and webhooks. The API uses bearer tokens and scopes.
- **Structured results:** Each self-hosted run writes `vulnerabilities.json`, `vulnerabilities.csv`, and `findings.sarif` in SARIF 2.1.0 format. It also writes per-finding Markdown under `strix_runs/<run-name>/`. The cloud exposes the same data as JSON and provides SARIF export.
- **Budget controls:** `--max-budget` and `--max-turns` set cost and turn limits.
- **`AGENTS.md`:** The [repository's agent guide](https://github.com/usestrix/strix/blob/main/AGENTS.md) provides a quick reference.
- **`llms.txt`:** The index is available at [docs.strix.ai/llms.txt](https://docs.strix.ai/llms.txt). The full export is available at [docs.strix.ai/llms-full.txt](https://docs.strix.ai/llms-full.txt). Every page is also available as Markdown by appending `.md` to its URL.