From 82d1c0cec4718cfed74ba12593c24cf33aff9df8 Mon Sep 17 00:00:00 2001 From: 0xallam Date: Wed, 21 Jan 2026 15:10:07 -0800 Subject: [PATCH] docs: update configuration documentation - Add missing config options: STRIX_LLM_MAX_RETRIES, STRIX_MEMORY_COMPRESSOR_TIMEOUT, STRIX_TELEMETRY - Remove non-existent options: LLM_RATE_LIMIT_DELAY, LLM_RATE_LIMIT_CONCURRENT - Fix defaults: STRIX_SANDBOX_EXECUTION_TIMEOUT (500 -> 120), STRIX_IMAGE (0.1.10 -> 0.1.11) - Add config file documentation section - Add --config CLI option to cli.mdx --- docs/advanced/configuration.mdx | 52 ++++++++++++++++++++++++--------- docs/usage/cli.mdx | 4 +++ 2 files changed, 42 insertions(+), 14 deletions(-) diff --git a/docs/advanced/configuration.mdx b/docs/advanced/configuration.mdx index c40385b..61e6423 100644 --- a/docs/advanced/configuration.mdx +++ b/docs/advanced/configuration.mdx @@ -3,7 +3,7 @@ title: "Configuration" description: "Environment variables for Strix" --- -Configure Strix using environment variables. +Configure Strix using environment variables or a config file. ## LLM Configuration @@ -23,27 +23,35 @@ Configure Strix using environment variables. Request timeout in seconds for LLM calls. - - Delay in seconds between LLM requests for rate limiting. - - - - Maximum concurrent LLM requests. + + Maximum number of retries for LLM API calls on transient failures. Control thinking effort for reasoning models. Valid values: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`. Defaults to `medium` for quick scan mode. + + Timeout in seconds for memory compression operations (context summarization). + + ## Optional Features API key for Perplexity AI. Enables real-time web search during scans for OSINT and vulnerability research. + + Disable browser automation tools. + + + + Enable/disable anonymous telemetry. Set to `0`, `false`, `no`, or `off` to disable. + + ## Docker Configuration - + Docker image to use for the sandbox container. @@ -57,17 +65,33 @@ Configure Strix using environment variables. ## Sandbox Configuration - + Maximum execution time in seconds for sandbox operations. - + Timeout in seconds for connecting to the sandbox container. - - Disable browser tool. - +## Config File + +Strix stores configuration in `~/.strix/cli-config.json`. You can also specify a custom config file: + +```bash +strix --target ./app --config /path/to/config.json +``` + +**Config file format:** + +```json +{ + "env": { + "STRIX_LLM": "openai/gpt-5", + "LLM_API_KEY": "sk-...", + "STRIX_REASONING_EFFORT": "high" + } +} +``` ## Example Setup @@ -81,7 +105,7 @@ export PERPLEXITY_API_KEY="pplx-..." # Optional: Custom timeouts export LLM_TIMEOUT="600" -export STRIX_SANDBOX_EXECUTION_TIMEOUT="1000" +export STRIX_SANDBOX_EXECUTION_TIMEOUT="300" # Optional: Use custom Docker image export STRIX_IMAGE="ghcr.io/usestrix/strix-sandbox:latest" diff --git a/docs/usage/cli.mdx b/docs/usage/cli.mdx index 75d935c..bfb4e15 100644 --- a/docs/usage/cli.mdx +++ b/docs/usage/cli.mdx @@ -31,6 +31,10 @@ strix --target [options] Run in headless mode without TUI. Ideal for CI/CD. + + Path to a custom config file (JSON) to use instead of `~/.strix/cli-config.json`. + + ## Examples ```bash