chore: polish and cleanup

Author: DevelopmentCats

registry/coder-labs/modules/codex/README.md

@@ -25,9 +25,9 @@ module "codex" {
 - You must add the [Coder Login](https://registry.coder.com/modules/coder/coder-login) module to your template
 - OpenAI API key for Codex access
 
-## Usage Examples
+## Examples
 
-### **Simple Usage**
+### **Run standalone**
 
 ```tf
 module "codex" {
@@ -36,15 +36,14 @@ module "codex" {
   version             = "1.0.2"
   agent_id            = coder_agent.example.id
   openai_api_key      = "..."
-  codex_model         = "o4-mini"
   install_codex       = true
   codex_version       = "latest"
   folder              = "/home/coder/project"
   codex_system_prompt = "You are a helpful coding assistant. Start every response with `Codex says:`"
 }
 ```
 
-### **Tasks Integration**
+### **Tasks integration**
 
 ```tf
 data "coder_parameter" "ai_prompt" {
@@ -78,8 +77,7 @@ module "codex" {
 }
 ```
 
-> [!WARNING]
-> **Security Notice**: This module configures Codex with a `workspace-write` sandbox that allows AI tasks to read/write files in the specified folder. While the sandbox provides security boundaries, Codex can still modify files within the workspace. Use this module in trusted environments and be aware of the security implications.
+> **Security Notice**: This module configures Codex with a `workspace-write` sandbox that allows AI tasks to read/write files in the specified folder. While the sandbox provides security boundaries, Codex can still modify files within the workspace. Use this module _only_ in trusted environments and be aware of the security implications.
 
 ## How it Works
 
@@ -138,7 +136,7 @@ module "codex" {
 ```
 
 > [!NOTE]
-> If no custom configuration is provided, the module uses secure defaults. The Coder MCP server is always included automatically.
+> If no custom configuration is provided, the module uses secure defaults. The Coder MCP server is always included automatically. For advanced options, see [Codex config docs](https://github.com/openai/codex/blob/main/codex-rs/config.md).
 
 ## Troubleshooting
 

registry/coder-labs/modules/codex/main.tf

@@ -55,7 +55,7 @@ variable "codex_version" {
 
 variable "base_config_toml" {
   type        = string
-  description = "Complete base TOML configuration for Codex (without mcp_servers section). If empty, uses minimal default configuration with workspace-write sandbox mode and on-request approval policy."
+  description = "Complete base TOML configuration for Codex (without mcp_servers section). If empty, uses minimal default configuration with workspace-write sandbox mode and never approval policy. For advanced options, see https://github.com/openai/codex/blob/main/codex-rs/config.md"
   default     = ""
 }
 
@@ -67,7 +67,7 @@ variable "additional_mcp_servers" {
 
 variable "openai_api_key" {
   type        = string
-  description = "Codex API Key"
+  description = "OpenAI API key for Codex CLI"
   default     = ""
 }
 
@@ -85,7 +85,7 @@ variable "agentapi_version" {
 
 variable "codex_model" {
   type        = string
-  description = "The model for Codex to use (e.g., o4-mini)."
+  description = "The model for Codex to use. Defaults to gpt-5."
   default     = ""
 }
 
@@ -103,14 +103,13 @@ variable "post_install_script" {
 
 variable "ai_prompt" {
   type        = string
-  description = "Task prompt for the Codex CLI"
+  description = "Initial task prompt for Codex CLI when launched via Tasks"
   default     = ""
 }
 
-
 variable "codex_system_prompt" {
   type        = string
-  description = "System prompt for Codex. It will be added to AGENTS.md in the specified folder."
+  description = "System instructions written to AGENTS.md in the ~/.codex directory"
   default     = ""
 }
 

registry/coder-labs/modules/codex/scripts/install.sh

@@ -15,16 +15,15 @@ ARG_BASE_CONFIG_TOML=$(echo -n "$ARG_BASE_CONFIG_TOML" | base64 -d)
 ARG_ADDITIONAL_MCP_SERVERS=$(echo -n "$ARG_ADDITIONAL_MCP_SERVERS" | base64 -d)
 ARG_CODEX_INSTRUCTION_PROMPT=$(echo -n "$ARG_CODEX_INSTRUCTION_PROMPT" | base64 -d)
 
-echo "--------------------------------"
-printf "install: %s\n" "$ARG_INSTALL"
-printf "codex_version: %s\n" "$ARG_CODEX_VERSION"
-printf "base_config_toml: %s\n" "$ARG_BASE_CONFIG_TOML"
-printf "additional_mcp_servers: %s\n" "$ARG_ADDITIONAL_MCP_SERVERS"
-printf "app_slug: %s\n" "$ARG_CODER_MCP_APP_STATUS_SLUG"
-printf "start_directory: %s\n" "$ARG_CODEX_START_DIRECTORY"
-printf "instruction_prompt: %s\n" "$ARG_CODEX_INSTRUCTION_PROMPT"
-
-echo "--------------------------------"
+echo "=== Codex Module Configuration ==="
+printf "Install Codex: %s\n" "$ARG_INSTALL"
+printf "Codex Version: %s\n" "$ARG_CODEX_VERSION"
+printf "App Slug: %s\n" "$ARG_CODER_MCP_APP_STATUS_SLUG"
+printf "Start Directory: %s\n" "$ARG_CODEX_START_DIRECTORY"
+printf "Has Base Config: %s\n" "$([ -n "$ARG_BASE_CONFIG_TOML" ] && echo "Yes" || echo "No")"
+printf "Has Additional MCP: %s\n" "$([ -n "$ARG_ADDITIONAL_MCP_SERVERS" ] && echo "Yes" || echo "No")"
+printf "Has System Prompt: %s\n" "$([ -n "$ARG_CODEX_INSTRUCTION_PROMPT" ] && echo "Yes" || echo "No")"
+echo "======================================"
 
 set +o nounset
 

registry/coder-labs/modules/codex/scripts/start.sh

@@ -18,12 +18,12 @@ printf "Version: %s\n" "$(codex --version)"
 set -o nounset
 ARG_CODEX_TASK_PROMPT=$(echo -n "$ARG_CODEX_TASK_PROMPT" | base64 -d)
 
-echo "--------------------------------"
-printf "openai_api_key: %s\n" "$ARG_OPENAI_API_KEY"
-printf "codex_model: %s\n" "$ARG_CODEX_MODEL"
-printf "start_directory: %s\n" "$ARG_CODEX_START_DIRECTORY"
-printf "task_prompt: %s\n" "$ARG_CODEX_TASK_PROMPT"
-echo "--------------------------------"
+echo "=== Codex Launch Configuration ==="
+printf "OpenAI API Key: %s\n" "$([ -n "$ARG_OPENAI_API_KEY" ] && echo "Provided" || echo "Not provided")"
+printf "Codex Model: %s\n" "${ARG_CODEX_MODEL:-"Default"}"
+printf "Start Directory: %s\n" "$ARG_CODEX_START_DIRECTORY"
+printf "Has Task Prompt: %s\n" "$([ -n "$ARG_CODEX_TASK_PROMPT" ] && echo "Yes" || echo "No")"
+echo "======================================"
 set +o nounset
 CODEX_ARGS=()
 
@@ -66,13 +66,9 @@ else
   printf "No task prompt given.\n"
 fi
 
-if [ -n "$ARG_OPENAI_API_KEY" ]; then
-  printf "openai_api_key provided !\n"
-else
-  printf "openai_api_key not provided\n"
-fi
 
-# use low width to fit in the tasks UI sidebar
-# we adjust the height to 930 due to a bug in codex, see: https://github.com/openai/codex/issues/1608
-printf "Starting codex with %s\n" "${CODEX_ARGS[@]}"
+# Terminal dimensions optimized for Coder Tasks UI sidebar:
+# - Width 67: fits comfortably in sidebar
+# - Height 1190: adjusted due to Codex terminal height bug (see: https://github.com/openai/codex/issues/1608)
+printf "Starting Codex with arguments: %s\n" "${CODEX_ARGS[*]}"
 agentapi server --term-width 67 --term-height 1190 -- codex "${CODEX_ARGS[@]}"