mirror of
https://github.com/usestrix/strix.git
synced 2026-10-12 03:47:56 +00:00
0fd17f8c4e
Remove the Makefile and move all tasks into mise.toml (setup-dev, check-all, dev, format/lint/type-check/security, pre-commit, clean, docs). Update the release workflow to use jdx/mise-action and refresh contributor/install docs to use mise commands.
81 lines
1.5 KiB
Text
81 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="mise (pipx)">
|
|
```bash
|
|
mise use -g "pipx:strix-agent"
|
|
```
|
|
</Tab>
|
|
<Tab title="mise (github)">
|
|
```bash
|
|
mise use -g "github:usestrix/strix"
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Configuration
|
|
|
|
Set your LLM provider:
|
|
|
|
```bash
|
|
export STRIX_LLM="openai/gpt-5.4"
|
|
export LLM_API_KEY="your-api-key"
|
|
```
|
|
|
|
<Tip>
|
|
For best results, use `openai/gpt-5.4`, `anthropic/claude-opus-4-6`, or `openai/gpt-5.2`.
|
|
</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
|
|
```
|
|
|
|
## 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>
|