mirror of
https://github.com/usestrix/strix.git
synced 2026-09-15 23:31:27 +00:00
0ab7244807
Add Claude Fable 5.1, Gemini 3.7 Flash, and Z.ai GLM-5.3 / GLM-5.3-Flash to RECOMMENDED_MODEL_NAMES, add a Z.ai GLM frontier family so GLM-5.x is accepted through OpenRouter and Novita routes, and drop the superseded GPT-5.4, GPT-5.3-codex, Opus 4.8, Sonnet 4.6, Gemini 3.6 Flash, and Qwen3.7 entries. Update the README, docs provider pages, quickstart, and CLI hint strings to the same current models, including DeepSeek V4, Kimi K3, and GLM-5.3.
79 lines
1.5 KiB
Text
79 lines
1.5 KiB
Text
---
|
|
title: "Quick Start"
|
|
description: "Install Strix and run your first security scan"
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
- Docker (running)
|
|
- An LLM API key from any [supported provider](/llm-providers/overview) (OpenAI, Anthropic, Google, etc.)
|
|
|
|
## Installation
|
|
|
|
<Tabs>
|
|
<Tab title="curl">
|
|
```bash
|
|
curl -sSL https://strix.ai/install | bash
|
|
```
|
|
</Tab>
|
|
<Tab title="pipx">
|
|
```bash
|
|
pipx install strix-agent
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Configuration
|
|
|
|
Set your LLM provider:
|
|
|
|
```bash
|
|
export STRIX_LLM="openai/gpt-5.6"
|
|
export LLM_API_KEY="your-api-key"
|
|
```
|
|
|
|
<Tip>
|
|
For best results, use `openai/gpt-5.6`, `anthropic/claude-opus-5`, or `deepseek/deepseek-v4-pro`.
|
|
</Tip>
|
|
|
|
## Run Your First Scan
|
|
|
|
```bash
|
|
strix --target ./your-app
|
|
```
|
|
|
|
<Note>
|
|
First run pulls the Docker sandbox image automatically. Results are saved to `strix_runs/<run-name>`.
|
|
</Note>
|
|
|
|
## Target Types
|
|
|
|
Strix accepts multiple target types:
|
|
|
|
```bash
|
|
# Local codebase
|
|
strix --target ./app-directory
|
|
|
|
# GitHub repository
|
|
strix --target https://github.com/org/repo
|
|
|
|
# Live web application
|
|
strix --target https://your-app.com
|
|
|
|
# Multiple targets (white-box testing)
|
|
strix -t https://github.com/org/repo -t https://your-app.com
|
|
|
|
# Targets from a file, one target per non-empty, non-comment line
|
|
strix --target-list ./targets.txt
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="CLI Options" icon="terminal" href="/usage/cli">
|
|
Explore all command-line options.
|
|
</Card>
|
|
<Card title="Scan Modes" icon="gauge" href="/usage/scan-modes">
|
|
Choose the right scan depth.
|
|
</Card>
|
|
</CardGroup>
|