diff --git a/README.md b/README.md index 1811d5d..4a84b6a 100644 --- a/README.md +++ b/README.md @@ -29,12 +29,15 @@ Strix
-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! +> [!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/`. -### ☁️ 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! + +
+Star History Chart +
+