From d16bdb277a2b7d6a283be5609237ac25d2531b1f Mon Sep 17 00:00:00 2001 From: Ahmed Allam <49919286+0xallam@users.noreply.github.com> Date: Wed, 14 Jan 2026 05:00:16 +0400 Subject: [PATCH] Update README --- README.md | 79 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 43 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index ab01e76..38e6552 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,61 @@

- Strix Logo + Strix Banner

-

Strix

- -

Open-source AI Hackers to secure your Apps

-
-[![Python](https://img.shields.io/pypi/pyversions/strix-agent?color=3776AB)](https://pypi.org/project/strix-agent/) -[![PyPI](https://img.shields.io/pypi/v/strix-agent?color=10b981)](https://pypi.org/project/strix-agent/) -[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE) -[![Docs](https://img.shields.io/badge/Docs-docs.strix.ai-10b981.svg)](https://docs.strix.ai) +# Strix -[![GitHub Stars](https://img.shields.io/github/stars/usestrix/strix)](https://github.com/usestrix/strix) -[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?&logo=discord&logoColor=white)](https://discord.gg/YjKFvEZSdZ) -[![Website](https://img.shields.io/badge/Website-strix.ai-2d3748.svg)](https://strix.ai) +### Open-source AI hackers to find and fix your app’s vulnerabilities. -usestrix%2Fstrix | Trendshift +
-[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/usestrix/strix) +Docs +Website +PyPI + +Ask DeepWiki +GitHub Stars +License +PyPI Version + + +Join Discord +Follow on X + + +usestrix/strix | Trendshift
-
+
- Strix Demo + Strix Demo

> [!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! +> **New!** Strix 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! --- -## 🦉 Strix Overview + +## Strix Overview Strix are autonomous AI agents that act just like real hackers - they run your code dynamically, find vulnerabilities, and validate them through actual 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. **Key Capabilities:** -- 🔧 **Full hacker toolkit** out of the box -- 🤝 **Teams of agents** that collaborate and scale -- ✅ **Real validation** with PoCs, not false positives -- 💻 **Developer‑first** CLI with actionable reports -- 🔄 **Auto‑fix & reporting** to accelerate remediation +- **Full hacker toolkit** out of the box +- **Teams of agents** that collaborate and scale +- **Real validation** with PoCs, not false positives +- **Developer‑first** CLI with actionable reports +- **Auto‑fix & reporting** to accelerate remediation ## 🎯 Use Cases @@ -87,7 +93,7 @@ strix --target ./app-directory > [!NOTE] > First run automatically pulls the sandbox Docker image. Results are saved to `strix_runs/` -## ☁️ Run Strix in Cloud +## Run Strix in Cloud Want to skip the local setup, API keys, and unpredictable LLM costs? Run the hosted cloud version of Strix at **[app.strix.ai](https://strix.ai)**. @@ -104,7 +110,7 @@ Launch a scan in just a few minutes—no setup or configuration required—and y ## ✨ Features -### 🛠️ Agentic Security Tools +### Agentic Security Tools Strix agents come equipped with a comprehensive security testing toolkit: @@ -116,7 +122,7 @@ Strix agents come equipped with a comprehensive security testing toolkit: - **Code Analysis** - Static and dynamic analysis capabilities - **Knowledge Management** - Structured findings and attack documentation -### 🎯 Comprehensive Vulnerability Detection +### Comprehensive Vulnerability Detection Strix can identify and validate a wide range of security vulnerabilities: @@ -128,7 +134,7 @@ Strix can identify and validate a wide range of security vulnerabilities: - **Authentication** - JWT vulnerabilities, session management - **Infrastructure** - Misconfigurations, exposed services -### 🕸️ Graph of Agents +### Graph of Agents Advanced multi-agent orchestration for comprehensive security testing: @@ -138,7 +144,7 @@ Advanced multi-agent orchestration for comprehensive security testing: --- -## 💻 Usage Examples +## Usage Examples ### Basic Usage @@ -169,7 +175,7 @@ strix --target api.your-app.com --instruction "Focus on business logic flaws and strix --target api.your-app.com --instruction-file ./instruction.md ``` -### 🤖 Headless Mode +### 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. @@ -177,7 +183,7 @@ Run Strix programmatically without interactive UI using the `-n/--non-interactiv strix -n --target https://your-app.com ``` -### 🔄 CI/CD (GitHub Actions) +### CI/CD (GitHub Actions) Strix can be added to your pipeline to run a security test on pull requests with a lightweight GitHub Actions workflow: @@ -204,7 +210,7 @@ jobs: run: strix -n -t ./ --scan-mode quick ``` -### ⚙️ Configuration +### Configuration ```bash export STRIX_LLM="openai/gpt-5" @@ -227,22 +233,23 @@ export STRIX_REASONING_EFFORT="high" # control thinking effort (default: high, See the [LLM Providers documentation](https://docs.strix.ai/llm-providers/overview) for all supported providers including Vertex AI, Bedrock, Azure, and local models. -## 📚 Documentation +## Documentation Full documentation is available at **[docs.strix.ai](https://docs.strix.ai)** — including detailed guides for usage, CI/CD integrations, skills, and advanced configuration. -## 🤝 Contributing +## Contributing We welcome contributions of code, docs, and new skills - check out our [Contributing Guide](https://docs.strix.ai/contributing) to get started or open a [pull request](https://github.com/usestrix/strix/pulls)/[issue](https://github.com/usestrix/strix/issues). -## 👥 Join Our Community +## Join Our Community Have questions? Found a bug? Want to contribute? **[Join our Discord!](https://discord.gg/YjKFvEZSdZ)** -## 🌟 Support the Project +## Support the Project **Love Strix?** Give us a ⭐ on GitHub! -## 🙏 Acknowledgements + +## Acknowledgements Strix builds on the incredible work of open-source projects like [LiteLLM](https://github.com/BerriAI/litellm), [Caido](https://github.com/caido/caido), [ProjectDiscovery](https://github.com/projectdiscovery), [Playwright](https://github.com/microsoft/playwright), and [Textual](https://github.com/Textualize/textual). Huge thanks to their maintainers!