mirror of
https://github.com/coder/coder.git
synced 2026-09-21 20:51:01 +08:00
fix(coderd/templatebuilder): shorten long module variable descriptions (#26747)
This commit is contained in:
@@ -53,7 +53,7 @@
|
||||
{
|
||||
"name": "api_key",
|
||||
"type": "string",
|
||||
"description": "API key for the selected AI provider. This will be set as the appropriate environment variable based on the provider.",
|
||||
"description": "API key for the selected AI provider.",
|
||||
"default": "",
|
||||
"required": false,
|
||||
"sensitive": true,
|
||||
@@ -62,7 +62,7 @@
|
||||
{
|
||||
"name": "base_aider_config",
|
||||
"type": "string",
|
||||
"description": "Base Aider configuration in yaml format. Will be stored in .aider.conf.yml file.\n \noptions include:\nread:\n - CONVENTIONS.md\n - anotherfile.txt\n - thirdfile.py\nmodel: xxx\n##Specify the OpenAI API key\nopenai-api-key: xxx\n## (deprecated, use --set-env OPENAI_API_TYPE=\u003cvalue\u003e)\nopenai-api-type: xxx\n## (deprecated, use --set-env OPENAI_API_VERSION=\u003cvalue\u003e)\nopenai-api-version: xxx\n## (deprecated, use --set-env OPENAI_API_DEPLOYMENT_ID=\u003cvalue\u003e)\nopenai-api-deployment-id: xxx\n## Set an environment variable (to control API settings, can be used multiple times)\nset-env: xxx\n## Specify multiple values like this:\nset-env:\n - xxx\n - yyy\n - zzz\n\nReference : https://aider.chat/docs/config/aider_conf.html\n",
|
||||
"description": "Base Aider configuration in YAML format. Stored in .aider.conf.yml.",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
"computed": false
|
||||
@@ -132,7 +132,7 @@
|
||||
{
|
||||
"name": "model",
|
||||
"type": "string",
|
||||
"description": "AI model to use with Aider. Can use Aider's built-in aliases like '4o' (gpt-4o), 'sonnet' (claude-3-7-sonnet), 'opus' (claude-3-opus), etc.",
|
||||
"description": "AI model to use with Aider.",
|
||||
"required": true,
|
||||
"sensitive": false,
|
||||
"computed": false
|
||||
|
||||
@@ -36,7 +36,7 @@
|
||||
{
|
||||
"name": "agentapi_chat_based_path",
|
||||
"type": "bool",
|
||||
"description": "Whether to use chat-based path for AgentAPI.Required if CODER_WILDCARD_ACCESS_URL is not defined in coder deployment",
|
||||
"description": "Use chat-based path for AgentAPI.",
|
||||
"default": false,
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
@@ -99,7 +99,7 @@
|
||||
{
|
||||
"name": "coder_mcp_instructions",
|
||||
"type": "string",
|
||||
"description": "Instructions for the Coder MCP server integration. This defines how the agent should report tasks to Coder.",
|
||||
"description": "Instructions for the Coder MCP server integration.",
|
||||
"default": "YOU MUST REPORT ALL TASKS TO CODER.\nWhen reporting tasks you MUST follow these EXACT instructions:\n- IMMEDIATELY report status after receiving ANY user message\n- Be granular If you are investigating with multiple steps report each step to coder.\n\nTask state MUST be one of the following:\n- Use \"state\": \"working\" when actively processing WITHOUT needing additional user input\n- Use \"state\": \"complete\" only when finished with a task\n- Use \"state\": \"failure\" when you need ANY user input lack sufficient details or encounter blockers.\n\nTask summaries MUST:\n- Include specifics about what you're doing\n- Include clear and actionable steps for the user\n- Be less than 160 characters in length\n",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
|
||||
@@ -37,7 +37,7 @@
|
||||
{
|
||||
"name": "claude_binary_path",
|
||||
"type": "string",
|
||||
"description": "Directory where the Claude Code binary is located. Use this if Claude is pre-installed or installed outside the module to a non-default location.",
|
||||
"description": "Directory where the Claude Code binary is located.",
|
||||
"default": "$HOME/.local/bin",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
@@ -46,7 +46,7 @@
|
||||
{
|
||||
"name": "claude_code_oauth_token",
|
||||
"type": "string",
|
||||
"description": "OAuth token passed to Claude Code via the CLAUDE_CODE_OAUTH_TOKEN env var. Generate one with `claude setup-token`.",
|
||||
"description": "OAuth token for Claude Code.",
|
||||
"default": "",
|
||||
"required": false,
|
||||
"sensitive": true,
|
||||
@@ -100,7 +100,7 @@
|
||||
{
|
||||
"name": "mcp",
|
||||
"type": "string",
|
||||
"description": "JSON-encoded string of MCP server configurations. When set, servers are added at Claude Code's user scope so they are available across every project the workspace owner opens.",
|
||||
"description": "JSON-encoded MCP server configurations for Claude Code.",
|
||||
"default": "",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
@@ -109,7 +109,7 @@
|
||||
{
|
||||
"name": "model",
|
||||
"type": "string",
|
||||
"description": "Sets the default model for Claude Code via ANTHROPIC_MODEL env var. If empty, Claude Code uses its default. Supports aliases (sonnet, opus) or full model names.",
|
||||
"description": "Default model for Claude Code via ANTHROPIC_MODEL env var.",
|
||||
"default": "",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
@@ -126,7 +126,7 @@
|
||||
{
|
||||
"name": "pre_install_script",
|
||||
"type": "string",
|
||||
"description": "Custom script to run before installing Claude Code. Can be used for dependency ordering between modules (e.g., waiting for git-clone to complete before Claude Code initialization).",
|
||||
"description": "Custom script to run before installing Claude Code.",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
"computed": false
|
||||
@@ -134,7 +134,7 @@
|
||||
{
|
||||
"name": "workdir",
|
||||
"type": "string",
|
||||
"description": "Optional project directory. When set, the module pre-creates it if missing and pre-accepts the Claude Code trust/onboarding prompt for it in ~/.claude.json.",
|
||||
"description": "Project directory. Pre-created if missing.",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
"computed": false
|
||||
|
||||
@@ -82,7 +82,7 @@
|
||||
{
|
||||
"name": "open_in",
|
||||
"type": "string",
|
||||
"description": "Determines where the app will be opened. Valid values are `\"tab\"` and `\"slim-window\" (default)`.\n`\"tab\"` opens in a new tab in the same browser window.\n`\"slim-window\"` opens a new browser window without navigation controls.\n",
|
||||
"description": "Where to open the app: \"tab\" or \"slim-window\" (default).",
|
||||
"default": "slim-window",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
|
||||
@@ -44,7 +44,7 @@
|
||||
{
|
||||
"name": "open_recent",
|
||||
"type": "bool",
|
||||
"description": "Open the most recent workspace or folder. Falls back to the folder if there is no recent workspace or folder to open.",
|
||||
"description": "Open the most recent workspace or folder.",
|
||||
"default": false,
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
|
||||
@@ -43,7 +43,7 @@
|
||||
{
|
||||
"name": "description",
|
||||
"type": "string",
|
||||
"description": "A custom description for the dotfiles parameter. This is shown in the UI - and allows you to customize the instructions you give to your users.",
|
||||
"description": "Custom description for the dotfiles parameter shown in the UI.",
|
||||
"default": "Enter a URL for a [dotfiles repository](https://dotfiles.github.io) to personalize your workspace. Use an SSH URL (e.g. `git@host:user/repo`) if your Git provider restricts HTTPS cloning.",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
@@ -52,7 +52,7 @@
|
||||
{
|
||||
"name": "dotfiles_branch",
|
||||
"type": "string",
|
||||
"description": "The branch to use for the dotfiles repository (optional, when set, the user isn't prompted for the branch)",
|
||||
"description": "Branch to use for the dotfiles repository.",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
"computed": false
|
||||
@@ -77,7 +77,7 @@
|
||||
{
|
||||
"name": "post_clone_script",
|
||||
"type": "string",
|
||||
"description": "Custom script to run after applying dotfiles. Runs every time, even if dotfiles were already applied.",
|
||||
"description": "Custom script to run after applying dotfiles.",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
"computed": false
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
{
|
||||
"name": "agent_name",
|
||||
"type": "string",
|
||||
"description": "The name of the coder_agent resource. Required when `subdomain` is `false` so the path-based base URL matches the URL Coder serves.",
|
||||
"description": "The name of the coder_agent resource.",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
"computed": false
|
||||
|
||||
@@ -52,7 +52,7 @@
|
||||
{
|
||||
"name": "post_clone_script",
|
||||
"type": "string",
|
||||
"description": "Custom script to run after cloning the repository. Runs always after git clone, even if the repository already exists.",
|
||||
"description": "Custom script to run after cloning the repository.",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
"computed": false
|
||||
@@ -60,7 +60,7 @@
|
||||
{
|
||||
"name": "pre_clone_script",
|
||||
"type": "string",
|
||||
"description": "Custom script to run before cloning the repository. Runs before git clone, even if the repository already exists.",
|
||||
"description": "Custom script to run before cloning the repository.",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
"computed": false
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
{
|
||||
"name": "config",
|
||||
"type": "string",
|
||||
"description": "A JSON string of JupyterLab server configuration settings. When set, writes ~/.jupyter/jupyter_server_config.json.",
|
||||
"description": "JupyterLab server configuration as a JSON string.",
|
||||
"default": "{}",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
|
||||
@@ -45,7 +45,7 @@
|
||||
{
|
||||
"name": "open_recent",
|
||||
"type": "bool",
|
||||
"description": "Open the most recent workspace or folder. Falls back to the folder if there is no recent workspace or folder to open.",
|
||||
"description": "Open the most recent workspace or folder.",
|
||||
"default": false,
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
{
|
||||
"name": "open_recent",
|
||||
"type": "bool",
|
||||
"description": "Open the most recent workspace or folder. Falls back to the folder if there is no recent workspace or folder to open.",
|
||||
"description": "Open the most recent workspace or folder.",
|
||||
"default": false,
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
|
||||
@@ -46,7 +46,7 @@
|
||||
{
|
||||
"name": "commit_id",
|
||||
"type": "string",
|
||||
"description": "Specify the commit ID of the VS Code Web binary to pin to a specific version. If left empty, the latest stable version is used.",
|
||||
"description": "Commit ID to pin VS Code Web to a specific version.",
|
||||
"default": "",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
|
||||
@@ -35,7 +35,7 @@
|
||||
{
|
||||
"name": "mcp",
|
||||
"type": "string",
|
||||
"description": "JSON-encoded string to configure MCP servers for Windsurf. When set, writes ~/.codeium/windsurf/mcp_config.json.",
|
||||
"description": "JSON-encoded MCP server configurations for Windsurf.",
|
||||
"default": "",
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
@@ -44,7 +44,7 @@
|
||||
{
|
||||
"name": "open_recent",
|
||||
"type": "bool",
|
||||
"description": "Open the most recent workspace or folder. Falls back to the folder if there is no recent workspace or folder to open.",
|
||||
"description": "Open the most recent workspace or folder.",
|
||||
"default": false,
|
||||
"required": false,
|
||||
"sensitive": false,
|
||||
|
||||
Reference in New Issue
Block a user