salvacybersec/strix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Readme

Browse Source 
Co-authored-by: m4ki3lf0 <m4ki3lf0@git.com>
Co-authored-by: Ahmed Allam <ahmed39652003@gmail.com>
This commit is contained in:
m4ki3lf0
2025-11-10 10:49:37 +01:00
committed by GitHub
parent b6d9d941cf
commit 1c8780cf81
1 changed files with 41 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
README.md
View File

@@ -29,12 +29,15 @@ Strix
<br />
<div align="center">
<img src=".github/screenshot.png" alt="Strix Demo" width="800" style="border-radius: 16px; box-shadow: 0 20px 40px rgba(0, 0, 0, 0.3), 0 0 0 1px rgba(255, 255, 255, 0.1), inset 0 1px 0 rgba(255, 255, 255, 0.2); transform: perspective(1000px) rotateX(2deg); transition: transform 0.3s ease;">
<img src=".github/screenshot.png" alt="Strix Demo" width="800" style="border-radius: 16px;">
</div>
> [!TIP]
> **New!** Strix now integrates seamlessly with GitHub Actions and CI/CD pipelines. Automatically scan for vulnerabilities on every pull request and block insecure code before it reaches production!
> [!WARNING]
> Only test systems you own or have permission to test. You are responsible for using Strix ethically and legally.
---
## 🦉 Strix Overview
@@ -79,10 +82,21 @@ strix --target ./app-directory
First run pulls the sandbox Docker image. Results are saved under `agent_runs/<run-name>`.
### ☁️ Cloud Hosted
### 🏆 Enterprise Platform
Want to skip the setup? Try our cloud-hosted version: **[usestrix.com](https://usestrix.com)**
Our managed platform provides:
- **📈 Executive Dashboards**
- **🧠 Custom Fine-Tuned Models**
- **⚙️ CI/CD Integration**
- **🔍 Large-Scale Scanning**
- **🔌 Third-Party Integrations**
- **🎯 Enterprise Support**
[**Get Enterprise Demo →**](https://usestrix.com)
## ✨ Features
### 🛠️ Agentic Security Tools
@@ -111,9 +125,10 @@ Want to skip the setup? Try our cloud-hosted version: **[usestrix.com](https://u
- **Scalable Testing** - Parallel execution for fast comprehensive coverage
- **Dynamic Coordination** - Agents collaborate and share discoveries
## 💻 Usage Examples
### Default Usage
```bash
# Local codebase analysis
strix --target ./app-directory
@@ -121,41 +136,25 @@ strix --target ./app-directory
# Repository security review
strix --target https://github.com/org/repo
# Web application assessment
# Black-Box Web application assessment
strix --target https://your-app.com
# Grey-Box Security Assesment
strix --target https://your-app.com --instructions "Perform authenticated testing using the following credentials user:pass"
# Multi-target white-box testing (source code + deployed app)
strix -t https://github.com/org/app -t https://your-app.com
# Test multiple environments simultaneously
strix -t https://dev.your-app.com -t https://staging.your-app.com -t https://prod.your-app.com
# Focused testing with instructions
strix --target api.your-app.com --instruction "Prioritize authentication and authorization testing"
# Testing with credentials
strix --target https://your-app.com --instruction "Test with credentials: testuser/testpass. Focus on privilege escalation and access control bypasses."
strix --target api.your-app.com --instruction "Focus on business logic flaws and IDOR vulnerabilities"
```
### ⚙️ Configuration
```bash
export STRIX_LLM="openai/gpt-5"
export LLM_API_KEY="your-api-key"
# Optional
export LLM_API_BASE="your-api-base-url" # if using a local model, e.g. Ollama, LMStudio
export PERPLEXITY_API_KEY="your-api-key" # for search capabilities
```
[📚 View supported AI models](https://docs.litellm.ai/docs/providers)
### 🤖 Headless Mode
Run Strix programmatically without interactive UI using the `-n/--non-interactive` flag—perfect for servers and automated jobs. The CLI prints real-time vulnerability findings, and the final report before exiting. Exits with non-zero code when vulnerabilities are found.
```bash
strix -n --target https://your-app.com --instruction "Focus on authentication and authorization vulnerabilities"
strix -n --target https://your-app.com
```
### 🔄 CI/CD (GitHub Actions)
@@ -185,26 +184,18 @@ jobs:
run: strix -n -t ./
```
## 🏆 Enterprise Platform
### ⚙️ Configuration
Our managed platform provides:
```bash
export STRIX_LLM="openai/gpt-5"
export LLM_API_KEY="your-api-key"
- **📈 Executive Dashboards**
- **🧠 Custom Fine-Tuned Models**
- **⚙️ CI/CD Integration**
- **🔍 Large-Scale Scanning**
- **🔌 Third-Party Integrations**
- **🎯 Enterprise Support**
# Optional
export LLM_API_BASE="your-api-base-url" # if using a local model, e.g. Ollama, LMStudio
export PERPLEXITY_API_KEY="your-api-key" # for search capabilities
```
[**Get Enterprise Demo →**](https://usestrix.com)
## 🔒 Security Architecture
- **Container Isolation** - All testing in sandboxed Docker environments
- **Local Processing** - Testing runs locally, no data sent to external services
> [!WARNING]
> Only test systems you own or have permission to test. You are responsible for using Strix ethically and legally.
[📚 View supported AI models](https://docs.litellm.ai/docs/providers)
## 🤝 Contributing
@@ -223,12 +214,16 @@ Help expand our collection of specialized prompt modules for AI agents:
- See [Prompt Modules Documentation](strix/prompts/README.md) for guidelines
- Submit via [pull requests](https://github.com/usestrix/strix/pulls) or [issues](https://github.com/usestrix/strix/issues)
## 🌟 Support the Project
**Love Strix?** Give us a ⭐ on GitHub!
## 👥 Join Our Community
Have questions? Found a bug? Want to contribute? **[Join our Discord!](https://discord.gg/YjKFvEZSdZ)**
## 🌟 Support the Project
**Love Strix?** Give us a ⭐ on GitHub!
<div align="center">
<img src="https://api.star-history.com/svg?repos=usestrix/strix&type=date&legend=top-left" alt="Star History Chart" width="800" style="border-radius: 16px;">
</div>
</div>