docs: add Scarf usage-analytics pixel to docs + README
Co-Authored-By: Alex Schapiro <bearsyankees@gmail.com>
This commit is contained in:
@@ -275,3 +275,5 @@ Strix builds on the incredible work of open-source projects like [LiteLLM](https
|
|||||||
> Only test apps you own or have permission to test. You are responsible for using Strix ethically and legally.
|
> Only test apps you own or have permission to test. You are responsible for using Strix ethically and legally.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|

|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Configuration"
|
|||||||
description: "Environment variables for Strix"
|
description: "Environment variables for Strix"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Configure Strix using environment variables or a config file.
|
Configure Strix using environment variables or a config file.
|
||||||
|
|
||||||
## LLM Configuration
|
## LLM Configuration
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Skills"
|
|||||||
description: "Specialized knowledge packages that enhance agent capabilities"
|
description: "Specialized knowledge packages that enhance agent capabilities"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Skills are structured knowledge packages that give Strix agents deep expertise in specific vulnerability types, technologies, and testing methodologies.
|
Skills are structured knowledge packages that give Strix agents deep expertise in specific vulnerability types, technologies, and testing methodologies.
|
||||||
|
|
||||||
## The Idea
|
## The Idea
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Introduction"
|
|||||||
description: "Managed security testing without local setup"
|
description: "Managed security testing without local setup"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Skip the setup. Run Strix in the cloud at [app.strix.ai](https://app.strix.ai).
|
Skip the setup. Run Strix in the cloud at [app.strix.ai](https://app.strix.ai).
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Contributing"
|
|||||||
description: "Contribute to Strix development"
|
description: "Contribute to Strix development"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
## Development Setup
|
## Development Setup
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Introduction"
|
|||||||
description: "Open-source AI hackers to secure your apps"
|
description: "Open-source AI hackers to secure your apps"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Strix are autonomous AI agents that act like real hackers—they run your code dynamically, find vulnerabilities, and validate them with proof-of-concepts. Built for developers and security teams who need fast, accurate security testing without the overhead of manual pentesting or the false positives of static analysis tools.
|
Strix are autonomous AI agents that act like real hackers—they run your code dynamically, find vulnerabilities, and validate them with proof-of-concepts. Built for developers and security teams who need fast, accurate security testing without the overhead of manual pentesting or the false positives of static analysis tools.
|
||||||
|
|
||||||
<Frame>
|
<Frame>
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "CI/CD Integration"
|
|||||||
description: "Run Strix in any CI/CD pipeline"
|
description: "Run Strix in any CI/CD pipeline"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Strix runs in headless mode for automated pipelines.
|
Strix runs in headless mode for automated pipelines.
|
||||||
|
|
||||||
## Headless Mode
|
## Headless Mode
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "GitHub Actions"
|
|||||||
description: "Run Strix security scans on every pull request"
|
description: "Run Strix security scans on every pull request"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Integrate Strix into your GitHub workflow to catch vulnerabilities before they reach production.
|
Integrate Strix into your GitHub workflow to catch vulnerabilities before they reach production.
|
||||||
|
|
||||||
## Basic Workflow
|
## Basic Workflow
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Anthropic"
|
|||||||
description: "Configure Strix with Claude models"
|
description: "Configure Strix with Claude models"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Azure OpenAI"
|
|||||||
description: "Configure Strix with OpenAI models via Azure"
|
description: "Configure Strix with OpenAI models via Azure"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "AWS Bedrock"
|
|||||||
description: "Configure Strix with models via AWS Bedrock"
|
description: "Configure Strix with models via AWS Bedrock"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Local Models"
|
|||||||
description: "Run Strix with self-hosted LLMs for privacy and air-gapped testing"
|
description: "Run Strix with self-hosted LLMs for privacy and air-gapped testing"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Running Strix with local models allows for completely offline, privacy-first security assessments. Data never leaves your machine, making this ideal for sensitive internal networks or air-gapped environments.
|
Running Strix with local models allows for completely offline, privacy-first security assessments. Data never leaves your machine, making this ideal for sensitive internal networks or air-gapped environments.
|
||||||
|
|
||||||
## Privacy vs Performance
|
## Privacy vs Performance
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Novita AI"
|
|||||||
description: "Configure Strix with Novita AI models"
|
description: "Configure Strix with Novita AI models"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
[Novita AI](https://novita.ai) provides fast, cost-efficient inference for open-source models via an OpenAI-compatible API.
|
[Novita AI](https://novita.ai) provides fast, cost-efficient inference for open-source models via an OpenAI-compatible API.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "OpenAI"
|
|||||||
description: "Configure Strix with OpenAI models"
|
description: "Configure Strix with OpenAI models"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "OpenRouter"
|
|||||||
description: "Configure Strix with models via OpenRouter"
|
description: "Configure Strix with models via OpenRouter"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
[OpenRouter](https://openrouter.ai) provides access to 100+ models from multiple providers through a single API.
|
[OpenRouter](https://openrouter.ai) provides access to 100+ models from multiple providers through a single API.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Overview"
|
|||||||
description: "Configure your AI model for Strix"
|
description: "Configure your AI model for Strix"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Strix uses [LiteLLM](https://docs.litellm.ai/docs/providers) for model compatibility, supporting 100+ LLM providers.
|
Strix uses [LiteLLM](https://docs.litellm.ai/docs/providers) for model compatibility, supporting 100+ LLM providers.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Google Vertex AI"
|
|||||||
description: "Configure Strix with Gemini models via Google Cloud"
|
description: "Configure Strix with Gemini models via Google Cloud"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Vertex AI requires the Google Cloud dependency. Install Strix with the vertex extra:
|
Vertex AI requires the Google Cloud dependency. Install Strix with the vertex extra:
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Quick Start"
|
|||||||
description: "Install Strix and run your first security scan"
|
description: "Install Strix and run your first security scan"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- Docker (running)
|
- Docker (running)
|
||||||
|
|||||||
@@ -0,0 +1,10 @@
|
|||||||
|
export const ScarfPixel = () => (
|
||||||
|
<img
|
||||||
|
referrerPolicy="no-referrer-when-downgrade"
|
||||||
|
src="https://static.scarf.sh/a.png?x-pxid=a0ba15dd-a205-4a54-95d6-7814e9ae6b61"
|
||||||
|
alt=""
|
||||||
|
width="1"
|
||||||
|
height="1"
|
||||||
|
style={{ position: "absolute", width: 0, height: 0, opacity: 0, pointerEvents: "none" }}
|
||||||
|
/>
|
||||||
|
);
|
||||||
@@ -3,6 +3,10 @@ title: "Browser"
|
|||||||
description: "Playwright-powered Chrome for web application testing"
|
description: "Playwright-powered Chrome for web application testing"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Strix uses a headless Chrome browser via Playwright to interact with web applications exactly like a real user would.
|
Strix uses a headless Chrome browser via Playwright to interact with web applications exactly like a real user would.
|
||||||
|
|
||||||
## How It Works
|
## How It Works
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Agent Tools"
|
|||||||
description: "How Strix agents interact with targets"
|
description: "How Strix agents interact with targets"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Strix agents use specialized tools to test your applications like a real penetration tester would.
|
Strix agents use specialized tools to test your applications like a real penetration tester would.
|
||||||
|
|
||||||
## Core Tools
|
## Core Tools
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "HTTP Proxy"
|
|||||||
description: "Caido-powered proxy for request interception and replay"
|
description: "Caido-powered proxy for request interception and replay"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Strix includes [Caido](https://caido.io), a modern HTTP proxy built for security testing. All browser traffic flows through Caido, giving the agent full control over requests and responses.
|
Strix includes [Caido](https://caido.io), a modern HTTP proxy built for security testing. All browser traffic flows through Caido, giving the agent full control over requests and responses.
|
||||||
|
|
||||||
## Capabilities
|
## Capabilities
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Sandbox Tools"
|
|||||||
description: "Pre-installed security tools in the Strix container"
|
description: "Pre-installed security tools in the Strix container"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Strix runs inside a Kali Linux-based Docker container with a comprehensive set of security tools pre-installed. The agent can use any of these tools through the [terminal](/tools/terminal).
|
Strix runs inside a Kali Linux-based Docker container with a comprehensive set of security tools pre-installed. The agent can use any of these tools through the [terminal](/tools/terminal).
|
||||||
|
|
||||||
## Reconnaissance
|
## Reconnaissance
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Terminal"
|
|||||||
description: "Bash shell for running commands and security tools"
|
description: "Bash shell for running commands and security tools"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Strix has access to a persistent bash terminal running inside the Docker sandbox. This gives the agent access to all [pre-installed security tools](/tools/sandbox).
|
Strix has access to a persistent bash terminal running inside the Docker sandbox. This gives the agent access to all [pre-installed security tools](/tools/sandbox).
|
||||||
|
|
||||||
## Capabilities
|
## Capabilities
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "CLI Reference"
|
|||||||
description: "Command-line options for Strix"
|
description: "Command-line options for Strix"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
## Basic Usage
|
## Basic Usage
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Custom Instructions"
|
|||||||
description: "Guide Strix with custom testing instructions"
|
description: "Guide Strix with custom testing instructions"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Use instructions to provide context, credentials, or focus areas for your scan.
|
Use instructions to provide context, credentials, or focus areas for your scan.
|
||||||
|
|
||||||
## Inline Instructions
|
## Inline Instructions
|
||||||
|
|||||||
@@ -3,6 +3,10 @@ title: "Scan Modes"
|
|||||||
description: "Choose the right scan depth for your use case"
|
description: "Choose the right scan depth for your use case"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import { ScarfPixel } from "/snippets/scarf-pixel.mdx";
|
||||||
|
|
||||||
|
<ScarfPixel />
|
||||||
|
|
||||||
Strix offers three scan modes to balance speed and thoroughness.
|
Strix offers three scan modes to balance speed and thoroughness.
|
||||||
|
|
||||||
## Quick
|
## Quick
|
||||||
|
|||||||
Reference in New Issue
Block a user