mirror of
https://github.com/usestrix/strix.git
synced 2026-08-16 17:27:26 +02:00
62 lines
3.6 KiB
Plaintext
62 lines
3.6 KiB
Plaintext
---
|
|
title: "Coding Agents"
|
|
description: "Use Strix from Claude Code, Cursor, Codex, and other AI agents"
|
|
---
|
|
|
|
Strix is built to be driven by AI coding agents. Install the official agent skills and your agent knows how to run pentests, remediate findings, and wire Strix into CI.
|
|
|
|
## Install the Skills
|
|
|
|
Works with any agent that supports the open [SKILL.md standard](https://agentskills.io): Claude Code, Cursor, Codex, Gemini CLI, OpenCode, and dozens more:
|
|
|
|
```bash
|
|
npx skills add usestrix/strix
|
|
```
|
|
|
|
| Skill | What your agent learns |
|
|
|-------|------------------------|
|
|
| `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) |
|
|
|
|
Install a single skill with `npx skills add usestrix/strix --skill penetration-testing-with-strix`, or use one without installing:
|
|
|
|
```bash
|
|
npx skills use usestrix/strix@penetration-testing-with-strix | claude
|
|
```
|
|
|
|
## Two ways to run: self-hosted or managed
|
|
|
|
Both use the same engine and produce the same validated findings and SARIF, so agents can pick per situation or combine them:
|
|
|
|
- **Open-source CLI (self-hosted)**: runs locally in a Docker sandbox with your own LLM key. Free, fully local, air-gap capable. Best for local dev loops and full control.
|
|
- **Managed cloud**: runs on Strix's infrastructure through the [app.strix.ai REST API](https://docs.app.strix.ai). No Docker, no LLM key, no local install, adds team dashboards, scheduling, PR reviews, and downloadable PDF/DOCX reports (Enterprise plan). Best in sandboxed/CI environments and for teams. Create an API token under **Settings → API Access**. The `managed-pentesting-with-strix` skill has the full flow.
|
|
|
|
## Agent-Friendly Interfaces
|
|
|
|
Everything an agent needs is machine-readable:
|
|
|
|
- **Headless CLI**: `strix -n` runs without the TUI and exits with `0` (clean), `1` (error), or `2` (vulnerabilities found).
|
|
- **REST API**: the managed platform exposes a documented [OpenAPI](https://docs.app.strix.ai/openapi.json) at `https://app.strix.ai/api/v1` (scans, vulnerabilities, assets, PR reviews, schedules, webhooks) with bearer tokens and scopes.
|
|
- **Structured results**: every run writes `vulnerabilities.json`, `vulnerabilities.csv`, `findings.sarif` (SARIF 2.1.0), and per-finding Markdown under `strix_runs/<run-name>/`. The cloud exposes the same as JSON plus SARIF export.
|
|
- **Budget controls**: `--max-budget` and `--max-turns` give agents hard cost/time caps.
|
|
- **`AGENTS.md`**: the [repository's agent guide](https://github.com/usestrix/strix/blob/main/AGENTS.md) with a quick reference.
|
|
- **`llms.txt`**: this documentation is indexed at [docs.strix.ai/llms.txt](https://docs.strix.ai/llms.txt) and fully exported 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.
|
|
|
|
## Example Prompts
|
|
|
|
Once the skills are installed, prompts like these just work:
|
|
|
|
```text
|
|
Pentest this repo with Strix (quick mode, $10 budget) and summarize the findings.
|
|
```
|
|
|
|
```text
|
|
Fix all critical and high findings from the last Strix run, then re-scan to verify.
|
|
```
|
|
|
|
```text
|
|
Add Strix security scanning to our GitHub Actions so every PR gets tested.
|
|
```
|