Add DREADNODE_CONSOLE. Update docs workflow triggers.

Author: monoxgas

.github/workflows/docs-update.yaml

@@ -21,15 +21,14 @@ jobs:
           private-key: ${{ secrets.UPDATE_DOCS_PRIVATE_KEY }}
           owner: "${{ github.repository_owner }}"
           repositories: |
-            sdk
             prod-docs
 
       - name: Trigger docs repository workflow
         uses: peter-evans/repository-dispatch@ff45666b9427631e3450c54a1bcbee4d9ff4d7c0 # v3.0.0
         with:
           token: ${{ steps.app-token.outputs.token }}
-          repository: dreadnode/prod-docs
-          event-type: code-update
+          repository: dreadnode/docs
+          event-type: docs-update
           client-payload: |
             {
               "repository": "${{ github.repository }}",

.secrets.baseline

@@ -167,9 +167,9 @@
         "filename": "docs/usage/config.mdx",
         "hashed_secret": "01eddf49c6b18f99f87ac7ba45e81d4a227e8d3f",
         "is_verified": false,
-        "line_number": 171
+        "line_number": 168
       }
     ]
   },
-  "generated_at": "2025-07-24T10:42:54Z"
+  "generated_at": "2025-07-27T06:07:06Z"
 }

docs/sdk/main.mdx

@@ -18,7 +18,7 @@ Dreadnode(
     project: str | None = None,
     service_name: str | None = None,
     service_version: str | None = None,
-    console: ConsoleOptions | Literal[False, True] = True,
+    console: ConsoleOptions | bool = True,
     send_to_logfire: bool
     | Literal["if-token-present"] = False,
     otel_scope: str = "dreadnode",
@@ -42,7 +42,7 @@ def __init__(
     project: str | None = None,
     service_name: str | None = None,
     service_version: str | None = None,
-    console: logfire.ConsoleOptions | t.Literal[False, True] = True,
+    console: logfire.ConsoleOptions | bool = True,
     send_to_logfire: bool | t.Literal["if-token-present"] = False,
     otel_scope: str = "dreadnode",
 ) -> None:
@@ -144,7 +144,7 @@ configure(
     project: str | None = None,
     service_name: str | None = None,
     service_version: str | None = None,
-    console: ConsoleOptions | Literal[False, True] = True,
+    console: ConsoleOptions | bool | None = None,
     send_to_logfire: bool
     | Literal["if-token-present"] = False,
     otel_scope: str = "dreadnode",
@@ -204,10 +204,10 @@ in the following order:
   )
   –The service version to use for OpenTelemetry.
 * **`console`**
-  (`ConsoleOptions | Literal[False, True]`, default:
-  `True`
+  (`ConsoleOptions | bool | None`, default:
+  `None`
   )
-  –Whether to log span information to the console.
+  –Whether to log span information to the console (`DREADNODE_CONSOLE` or the default is True).
 * **`send_to_logfire`**
   (`bool | Literal['if-token-present']`, default:
   `False`
@@ -231,7 +231,7 @@ def configure(
     project: str | None = None,
     service_name: str | None = None,
     service_version: str | None = None,
-    console: logfire.ConsoleOptions | t.Literal[False, True] = True,
+    console: logfire.ConsoleOptions | bool | None = None,
     send_to_logfire: bool | t.Literal["if-token-present"] = False,
     otel_scope: str = "dreadnode",
 ) -> None:
@@ -259,7 +259,7 @@ def configure(
         project: The default project name to associate all runs with.
         service_name: The service name to use for OpenTelemetry.
         service_version: The service version to use for OpenTelemetry.
-        console: Whether to log span information to the console.
+        console: Whether to log span information to the console (`DREADNODE_CONSOLE` or the default is True).
         send_to_logfire: Whether to send data to Logfire.
         otel_scope: The OpenTelemetry scope name.
     """
@@ -316,7 +316,11 @@ def configure(
     self.project = project or os.environ.get(ENV_PROJECT)
     self.service_name = service_name
     self.service_version = service_version
-    self.console = console
+    self.console = console or os.environ.get(ENV_CONSOLE, "true").lower() in [
+        "true",
+        "1",
+        "yes",
+    ]
     self.send_to_logfire = send_to_logfire
     self.otel_scope = otel_scope
 

docs/usage/config.mdx

@@ -133,20 +133,17 @@ Environment variables are a great alternative for automated deployments and CI/C
 ### Complete Reference
 
 ```bash
-# Authentication (choose one)
-export DREADNODE_API_KEY="your-api-token"        # Recommended
-export DREADNODE_API_TOKEN="your-api-token"      # Alternative
-
-# Server configuration
-export DREADNODE_SERVER="https://your-server.com"     # Recommended
-export DREADNODE_SERVER_URL="https://your-server.com" # Alternative
-
 # Profile selection (when not using explicit server/token)
 export DREADNODE_PROFILE="production"
 
+# Platform configuration
+export DREADNODE_API_KEY="your-api-token"
+export DREADNODE_SERVER="http://self-hosted"
+
 # Optional settings
-export DREADNODE_LOCAL_DIR="./runs"           # Local storage directory
-export DREADNODE_PROJECT="my-project"         # Default project name
+export DREADNODE_LOCAL_DIR="./runs"     # Local storage directory
+export DREADNODE_PROJECT="my-project"   # Default project name
+export DREADNODE_CONSOLE="true"         # Enable console logging (default is true)
 ```
 
 ## Configuration Priority Order

dreadnode/constants.py

@@ -39,6 +39,7 @@
 ENV_LOCAL_DIR = "DREADNODE_LOCAL_DIR"
 ENV_PROJECT = "DREADNODE_PROJECT"
 ENV_PROFILE = "DREADNODE_PROFILE"
+ENV_CONSOLE = "DREADNODE_CONSOLE"
 
 #
 # Environment

dreadnode/main.py

@@ -29,6 +29,7 @@
     DEFAULT_SERVER_URL,
     ENV_API_KEY,
     ENV_API_TOKEN,
+    ENV_CONSOLE,
     ENV_LOCAL_DIR,
     ENV_PROFILE,
     ENV_PROJECT,
@@ -100,7 +101,7 @@ class Dreadnode:
     project: str | None
     service_name: str | None
     service_version: str | None
-    console: logfire.ConsoleOptions | t.Literal[False, True]
+    console: logfire.ConsoleOptions | bool
     send_to_logfire: bool | t.Literal["if-token-present"]
     otel_scope: str
 
@@ -113,7 +114,7 @@ def __init__(
         project: str | None = None,
         service_name: str | None = None,
         service_version: str | None = None,
-        console: logfire.ConsoleOptions | t.Literal[False, True] = True,
+        console: logfire.ConsoleOptions | bool = True,
         send_to_logfire: bool | t.Literal["if-token-present"] = False,
         otel_scope: str = "dreadnode",
     ) -> None:
@@ -167,7 +168,7 @@ def configure(
         project: str | None = None,
         service_name: str | None = None,
         service_version: str | None = None,
-        console: logfire.ConsoleOptions | t.Literal[False, True] = True,
+        console: logfire.ConsoleOptions | bool | None = None,
         send_to_logfire: bool | t.Literal["if-token-present"] = False,
         otel_scope: str = "dreadnode",
     ) -> None:
@@ -195,7 +196,7 @@ def configure(
             project: The default project name to associate all runs with.
             service_name: The service name to use for OpenTelemetry.
             service_version: The service version to use for OpenTelemetry.
-            console: Whether to log span information to the console.
+            console: Whether to log span information to the console (`DREADNODE_CONSOLE` or the default is True).
             send_to_logfire: Whether to send data to Logfire.
             otel_scope: The OpenTelemetry scope name.
         """
@@ -252,7 +253,11 @@ def configure(
         self.project = project or os.environ.get(ENV_PROJECT)
         self.service_name = service_name
         self.service_version = service_version
-        self.console = console
+        self.console = console or os.environ.get(ENV_CONSOLE, "true").lower() in [
+            "true",
+            "1",
+            "yes",
+        ]
         self.send_to_logfire = send_to_logfire
         self.otel_scope = otel_scope