feat: Sourcegraph Amp module (#257)

Closes #238 /claim #238 ## Description Video - https://www.loom.com/share/59e80a7fa3e54973bb0318132bc849a7?sid=4900077a-6fdb-4760-978c-9ad2e2daa9d8 <img width="1365" height="599" alt="Screenshot 2025-08-02 164234" src="https://github.com/user-attachments/assets/56ec7dc3-bc41-4976-9b78-3d6c011d80fe" />  ## Type of Change - [x] New module - [ ] Bug fix - [ ] Feature/enhancement - [ ] Documentation - [ ] Other ## Module Information  **Path:** `registry/harsh9485]/modules/sourcegraph_amp` **New version:** `v1.0.0` **Breaking change:** [ ] Yes [x] No ## Testing & Validation - [x] Tests pass (`bun test`) - [x] Code formatted (`bun run fmt`) - [x] Changes tested locally ## Related Issues  --------- Co-authored-by: Atif Ali <atif@coder.com> Co-authored-by: DevCats <christofer@coder.com>
2026-06-02 20:48:14 +00:00 · 2025-08-20 01:55:17 +05:30
parent c554463d4d
commit 545a245530
7 changed files with 606 additions and 0 deletions
@@ -0,0 +1,5 @@
+<svg width="400" height="400" viewBox="0 0 19 19" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M3.41508 17.2983L7.88484 12.7653L9.51146 18.9412L11.8745 18.2949L9.52018 9.32758L0.69527 6.93747L0.066864 9.35199L6.13926 11.0015L1.68806 15.5279L3.41508 17.2983Z" fill="#F34E3F"/>
+<path d="M16.3044 12.0436L18.6675 11.3973L16.3132 2.43003L7.48824 0.0399246L6.85984 2.45444L14.312 4.47881L16.3044 12.0436Z" fill="#F34E3F"/>
+<path d="M12.9126 15.4902L15.2756 14.8439L12.9213 5.87659L4.09639 3.48648L3.46799 5.901L10.9201 7.92537L12.9126 15.4902Z" fill="#F34E3F"/>
+</svg>
@@ -0,0 +1,90 @@
+---
+display_name: Sourcegraph AMP
+icon: ../../../../.icons/sourcegraph-amp.svg
+description: Run Sourcegraph AMP CLI in your workspace with AgentAPI integration
+verified: false
+tags: [agent, sourcegraph, amp, ai, tasks]
+---
+
+# Sourcegraph AMP CLI
+
+Run [Sourcegraph AMP CLI](https://sourcegraph.com/amp) in your workspace to access Sourcegraph's AI-powered code search and analysis tools, with AgentAPI integration for seamless Coder Tasks support.
+
+```tf
+module "sourcegraph_amp" {
+  source                  = "registry.coder.com/coder-labs/sourcegraph_amp/coder"
+  version                 = "1.0.0"
+  agent_id                = coder_agent.example.id
+  sourcegraph_amp_api_key = var.sourcegraph_amp_api_key
+  install_sourcegraph_amp = true
+  agentapi_version        = "latest"
+}
+```
+
+## Prerequisites
+
+- Include the [Coder Login](https://registry.coder.com/modules/coder-login/coder) module in your template
+- Node.js and npm are automatically installed (via NVM) if not already available
+
+## Usage Example
+
+```tf
+data "coder_parameter" "ai_prompt" {
+  name        = "AI Prompt"
+  description = "Write an initial prompt for AMP to work on."
+  type        = "string"
+  default     = ""
+  mutable     = true
+
+}
+
+# Set system prompt for Sourcegraph Amp via environment variables
+resource "coder_agent" "main" {
+  # ...
+  env = {
+    SOURCEGRAPH_AMP_SYSTEM_PROMPT = <<-EOT
+      You are an AMP assistant that helps developers debug and write code efficiently.
+
+      Always log task status to Coder.
+    EOT
+    SOURCEGRAPH_AMP_TASK_PROMPT   = data.coder_parameter.ai_prompt.value
+  }
+}
+
+variable "sourcegraph_amp_api_key" {
+  type        = string
+  description = "Sourcegraph AMP API key"
+  sensitive   = true
+}
+
+module "sourcegraph_amp" {
+  count                   = data.coder_workspace.me.start_count
+  source                  = "registry.coder.com/coder-labs/sourcegraph_amp/coder"
+  version                 = "1.0.0"
+  agent_id                = coder_agent.example.id
+  sourcegraph_amp_api_key = var.sourcegraph_amp_api_key # recommended for authenticated usage
+  install_sourcegraph_amp = true
+}
+```
+
+## How it Works
+
+- **Install**: Installs Sourcegraph AMP CLI using npm (installs Node.js via NVM if required)
+- **Start**: Launches AMP CLI in the specified directory, wrapped with AgentAPI to enable tasks and AI interactions
+- **Environment Variables**: Sets `SOURCEGRAPH_AMP_API_KEY` and `SOURCEGRAPH_AMP_START_DIRECTORY` for the CLI execution
+
+## Troubleshooting
+
+- If `amp` is not found, ensure `install_sourcegraph_amp = true` and your API key is valid
+- Logs are written under `/home/coder/.sourcegraph-amp-module/` (`install.log`, `agentapi-start.log`) for debugging
+- If AgentAPI fails to start, verify that your container has network access and executable permissions for the scripts
+
+> [!IMPORTANT]
+> For using **Coder Tasks** with Sourcegraph AMP, make sure to pass the `AI Prompt` parameter and set `sourcegraph_amp_api_key`.
+> This ensures task reporting and status updates work seamlessly.
+
+## References
+
+- [Sourcegraph AMP Documentation](https://ampcode.com/manual)
+- [AgentAPI Documentation](https://github.com/coder/agentapi)
+- [Coder AI Agents Guide](https://coder.com/docs/tutorials/ai-agents)
@@ -0,0 +1,157 @@
+import {
+  test,
+  afterEach,
+  describe,
+  setDefaultTimeout,
+  beforeAll,
+  expect,
+} from "bun:test";
+import { execContainer, readFileContainer, runTerraformInit } from "~test";
+import {
+  loadTestFile,
+  writeExecutable,
+  setup as setupUtil,
+  execModuleScript,
+  expectAgentAPIStarted,
+} from "../../../coder/modules/agentapi/test-util";
+
+let cleanupFunctions: (() => Promise<void>)[] = [];
+const registerCleanup = (cleanup: () => Promise<void>) => {
+  cleanupFunctions.push(cleanup);
+};
+afterEach(async () => {
+  const cleanupFnsCopy = cleanupFunctions.slice().reverse();
+  cleanupFunctions = [];
+  for (const cleanup of cleanupFnsCopy) {
+    try {
+      await cleanup();
+    } catch (error) {
+      console.error("Error during cleanup:", error);
+    }
+  }
+});
+
+interface SetupProps {
+  skipAgentAPIMock?: boolean;
+  skipAmpMock?: boolean;
+  moduleVariables?: Record<string, string>;
+  agentapiMockScript?: string;
+}
+
+const setup = async (props?: SetupProps): Promise<{ id: string }> => {
+  const projectDir = "/home/coder/project";
+  const { id } = await setupUtil({
+    moduleDir: import.meta.dir,
+    moduleVariables: {
+      install_sourcegraph_amp: props?.skipAmpMock ? "true" : "false",
+      install_agentapi: props?.skipAgentAPIMock ? "true" : "false",
+      sourcegraph_amp_model: "test-model",
+      ...props?.moduleVariables,
+    },
+    registerCleanup,
+    projectDir,
+    skipAgentAPIMock: props?.skipAgentAPIMock,
+    agentapiMockScript: props?.agentapiMockScript,
+  });
+
+  // Place the AMP mock CLI binary inside the container
+  if (!props?.skipAmpMock) {
+    await writeExecutable({
+      containerId: id,
+      filePath: "/usr/bin/amp",
+      content: await loadTestFile(`${import.meta.dir}`, "amp-mock.sh"),
+    });
+  }
+
+  return { id };
+};
+
+setDefaultTimeout(60 * 1000);
+
+describe("sourcegraph-amp", async () => {
+  beforeAll(async () => {
+    await runTerraformInit(import.meta.dir);
+  });
+
+  test("happy-path", async () => {
+    const { id } = await setup();
+    await execModuleScript(id);
+    await expectAgentAPIStarted(id);
+  });
+
+  test("api-key", async () => {
+    const apiKey = "test-api-key-123";
+    const { id } = await setup({
+      moduleVariables: {
+        sourcegraph_amp_api_key: apiKey,
+      },
+    });
+    await execModuleScript(id);
+    const resp = await readFileContainer(
+      id,
+      "/home/coder/.sourcegraph-amp-module/agentapi-start.log",
+    );
+    expect(resp).toContain("sourcegraph_amp_api_key provided !");
+  });
+
+  test("custom-folder", async () => {
+    const folder = "/tmp/sourcegraph-amp-test";
+    const { id } = await setup({
+      moduleVariables: {
+        folder,
+      },
+    });
+    await execModuleScript(id);
+    const resp = await readFileContainer(
+      id,
+      "/home/coder/.sourcegraph-amp-module/install.log",
+    );
+    expect(resp).toContain(folder);
+  });
+
+  test("pre-post-install-scripts", async () => {
+    const { id } = await setup({
+      moduleVariables: {
+        pre_install_script: "#!/bin/bash\necho 'pre-install-script'",
+        post_install_script: "#!/bin/bash\necho 'post-install-script'",
+      },
+    });
+    await execModuleScript(id);
+    const preLog = await readFileContainer(
+      id,
+      "/home/coder/.sourcegraph-amp-module/pre_install.log",
+    );
+    expect(preLog).toContain("pre-install-script");
+    const postLog = await readFileContainer(
+      id,
+      "/home/coder/.sourcegraph-amp-module/post_install.log",
+    );
+    expect(postLog).toContain("post-install-script");
+  });
+
+  test("system-prompt", async () => {
+    const prompt = "this is a system prompt for AMP";
+    const { id } = await setup();
+    await execModuleScript(id, {
+      SOURCEGRAPH_AMP_SYSTEM_PROMPT: prompt,
+    });
+    const resp = await readFileContainer(
+      id,
+      "/home/coder/.sourcegraph-amp-module/SYSTEM_PROMPT.md",
+    );
+    expect(resp).toContain(prompt);
+  });
+
+  test("task-prompt", async () => {
+    const prompt = "this is a task prompt for AMP";
+    const { id } = await setup();
+    await execModuleScript(id, {
+      SOURCEGRAPH_AMP_TASK_PROMPT: prompt,
+    });
+    const resp = await readFileContainer(
+      id,
+      "/home/coder/.sourcegraph-amp-module/agentapi-start.log",
+    );
+    expect(resp).toContain(`sourcegraph amp task prompt provided : ${prompt}`);
+  });
+});
@@ -0,0 +1,195 @@
+terraform {
+  required_version = ">= 1.0"
+
+  required_providers {
+    coder = {
+      source  = "coder/coder"
+      version = ">= 2.7"
+    }
+  }
+}
+
+variable "agent_id" {
+  type        = string
+  description = "The ID of a Coder agent."
+}
+
+data "coder_workspace" "me" {}
+
+data "coder_workspace_owner" "me" {}
+
+variable "order" {
+  type        = number
+  description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
+  default     = null
+}
+
+variable "group" {
+  type        = string
+  description = "The name of a group that this app belongs to."
+  default     = null
+}
+
+variable "icon" {
+  type        = string
+  description = "The icon to use for the app."
+  default     = "/icon/sourcegraph-amp.svg"
+}
+
+variable "folder" {
+  type        = string
+  description = "The folder to run sourcegraph_amp in."
+  default     = "/home/coder"
+}
+
+variable "install_sourcegraph_amp" {
+  type        = bool
+  description = "Whether to install sourcegraph-amp."
+  default     = true
+}
+
+variable "sourcegraph_amp_api_key" {
+  type        = string
+  description = "sourcegraph-amp API Key"
+  default     = ""
+}
+
+resource "coder_env" "sourcegraph_amp_api_key" {
+  agent_id = var.agent_id
+  name     = "SOURCEGRAPH_AMP_API_KEY"
+  value    = var.sourcegraph_amp_api_key
+}
+
+variable "install_agentapi" {
+  type        = bool
+  description = "Whether to install AgentAPI."
+  default     = true
+}
+
+variable "agentapi_version" {
+  type        = string
+  description = "The version of AgentAPI to install."
+  default     = "v0.3.0"
+}
+
+variable "pre_install_script" {
+  type        = string
+  description = "Custom script to run before installing sourcegraph_amp"
+  default     = null
+}
+
+variable "post_install_script" {
+  type        = string
+  description = "Custom script to run after installing sourcegraph_amp."
+  default     = null
+}
+
+variable "base_amp_config" {
+  type        = string
+  description = <<-EOT
+    Base AMP configuration in JSON format. Can be overridden to customize AMP settings.
+    
+    If empty, defaults enable thinking and todos for autonomous operation. Additional options include:
+    - "amp.permissions": [] (tool permissions)
+    - "amp.tools.stopTimeout": 600 (extend timeout for long operations)
+    - "amp.terminal.commands.nodeSpawn.loadProfile": "daily" (environment loading)
+    - "amp.tools.disable": ["builtin:open"] (disable tools for containers)
+    - "amp.git.commit.ampThread.enabled": true (link commits to threads)
+    - "amp.git.commit.coauthor.enabled": true (add Amp as co-author)
+    
+    Reference: https://ampcode.com/manual
+  EOT
+  default     = ""
+}
+
+variable "additional_mcp_servers" {
+  type        = string
+  description = "Additional MCP servers configuration in JSON format to append to amp.mcpServers."
+  default     = null
+}
+
+locals {
+  app_slug = "amp"
+
+  default_base_config = {
+    "amp.anthropic.thinking.enabled" = true
+    "amp.todos.enabled"              = true
+  }
+
+  # Use provided config or default, then extract base settings (excluding mcpServers)
+  user_config       = var.base_amp_config != "" ? jsondecode(var.base_amp_config) : local.default_base_config
+  base_amp_settings = { for k, v in local.user_config : k => v if k != "amp.mcpServers" }
+
+  coder_mcp = {
+    "coder" = {
+      "command" = "coder"
+      "args"    = ["exp", "mcp", "server"]
+      "env" = {
+        "CODER_MCP_APP_STATUS_SLUG" = local.app_slug
+        "CODER_MCP_AI_AGENTAPI_URL" = "http://localhost:3284"
+      }
+      "type" = "stdio"
+    }
+  }
+
+  additional_mcp = var.additional_mcp_servers != null ? jsondecode(var.additional_mcp_servers) : {}
+
+  merged_mcp_servers = merge(
+    lookup(local.user_config, "amp.mcpServers", {}),
+    local.coder_mcp,
+    local.additional_mcp
+  )
+
+  final_config = merge(local.base_amp_settings, {
+    "amp.mcpServers" = local.merged_mcp_servers
+  })
+
+  install_script  = file("${path.module}/scripts/install.sh")
+  start_script    = file("${path.module}/scripts/start.sh")
+  module_dir_name = ".sourcegraph-amp-module"
+}
+
+module "agentapi" {
+  source  = "registry.coder.com/coder/agentapi/coder"
+  version = "1.0.1"
+
+  agent_id             = var.agent_id
+  web_app_slug         = local.app_slug
+  web_app_order        = var.order
+  web_app_group        = var.group
+  web_app_icon         = var.icon
+  web_app_display_name = "Sourcegraph Amp"
+  cli_app_slug         = "${local.app_slug}-cli"
+  cli_app_display_name = "Sourcegraph Amp CLI"
+  module_dir_name      = local.module_dir_name
+  install_agentapi     = var.install_agentapi
+  agentapi_version     = var.agentapi_version
+  pre_install_script   = var.pre_install_script
+  post_install_script  = var.post_install_script
+  start_script         = <<-EOT
+     #!/bin/bash
+     set -o errexit
+     set -o pipefail
+
+     echo -n '${base64encode(local.start_script)}' | base64 -d > /tmp/start.sh
+     chmod +x /tmp/start.sh
+     SOURCEGRAPH_AMP_API_KEY='${var.sourcegraph_amp_api_key}' \
+     SOURCEGRAPH_AMP_START_DIRECTORY='${var.folder}' \
+     /tmp/start.sh
+   EOT
+
+  install_script = <<-EOT
+    #!/bin/bash
+    set -o errexit
+    set -o pipefail
+
+    echo -n '${base64encode(local.install_script)}' | base64 -d > /tmp/install.sh
+    chmod +x /tmp/install.sh
+    ARG_INSTALL_SOURCEGRAPH_AMP='${var.install_sourcegraph_amp}' \
+    SOURCEGRAPH_AMP_START_DIRECTORY='${var.folder}' \
+    ARG_AMP_CONFIG="$(echo -n '${base64encode(jsonencode(local.final_config))}' | base64 -d)" \
+    /tmp/install.sh
+  EOT
+}
+
+
@@ -0,0 +1,96 @@
+#!/bin/bash
+set -euo pipefail
+
+# ANSI colors
+BOLD='\033[1m'
+
+echo "--------------------------------"
+echo "Install flag: $ARG_INSTALL_SOURCEGRAPH_AMP"
+echo "Workspace: $SOURCEGRAPH_AMP_START_DIRECTORY"
+echo "--------------------------------"
+
+# Helper function to check if a command exists
+command_exists() {
+  command -v "$1" > /dev/null 2>&1
+}
+
+function install_node() {
+  if ! command_exists npm; then
+    printf "npm not found, checking for Node.js installation...\n"
+    if ! command_exists node; then
+      printf "Node.js not found, installing Node.js via NVM...\n"
+      export NVM_DIR="$HOME/.nvm"
+      if [ ! -d "$NVM_DIR" ]; then
+        mkdir -p "$NVM_DIR"
+        curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
+        [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+      else
+        [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+      fi
+
+      # Temporarily disable nounset (-u) for nvm to avoid PROVIDED_VERSION error
+      set +u
+      nvm install --lts
+      nvm use --lts
+      nvm alias default node
+      set -u
+
+      printf "Node.js installed: %s\n" "$(node --version)"
+      printf "npm installed: %s\n" "$(npm --version)"
+    else
+      printf "Node.js is installed but npm is not available. Please install npm manually.\n"
+      exit 1
+    fi
+  fi
+}
+
+function install_sourcegraph_amp() {
+  if [ "${ARG_INSTALL_SOURCEGRAPH_AMP}" = "true" ]; then
+    install_node
+
+    # If nvm is not used, set up user npm global directory
+    if ! command_exists nvm; then
+      mkdir -p "$HOME/.npm-global"
+      npm config set prefix "$HOME/.npm-global"
+      export PATH="$HOME/.npm-global/bin:$PATH"
+      if ! grep -q "export PATH=$HOME/.npm-global/bin:\$PATH" ~/.bashrc; then
+        echo "export PATH=$HOME/.npm-global/bin:\$PATH" >> ~/.bashrc
+      fi
+    fi
+
+    printf "%s Installing Sourcegraph AMP CLI...\n" "${BOLD}"
+    npm install -g @sourcegraph/amp@0.0.1754179307-gba1f97
+    printf "%s Successfully installed Sourcegraph AMP CLI. Version: %s\n" "${BOLD}" "$(amp --version)"
+  fi
+}
+
+function setup_system_prompt() {
+  if [ -n "${SOURCEGRAPH_AMP_SYSTEM_PROMPT:-}" ]; then
+    echo "Setting Sourcegraph AMP system prompt..."
+    mkdir -p "$HOME/.sourcegraph-amp-module"
+    echo "$SOURCEGRAPH_AMP_SYSTEM_PROMPT" > "$HOME/.sourcegraph-amp-module/SYSTEM_PROMPT.md"
+    echo "System prompt saved to $HOME/.sourcegraph-amp-module/SYSTEM_PROMPT.md"
+  else
+    echo "No system prompt provided for Sourcegraph AMP."
+  fi
+}
+
+function configure_amp_settings() {
+  echo "Configuring AMP settings..."
+  SETTINGS_PATH="$HOME/.config/amp/settings.json"
+  mkdir -p "$(dirname "$SETTINGS_PATH")"
+
+  if [ -z "${ARG_AMP_CONFIG:-}" ]; then
+    echo "No AMP config provided, skipping configuration"
+    return
+  fi
+
+  echo "Writing AMP configuration to $SETTINGS_PATH"
+  printf '%s\n' "$ARG_AMP_CONFIG" > "$SETTINGS_PATH"
+
+  echo "AMP configuration complete"
+}
+
+install_sourcegraph_amp
+setup_system_prompt
+configure_amp_settings
@@ -0,0 +1,49 @@
+#!/bin/bash
+set -euo pipefail
+
+# Load user environment
+# shellcheck source=/dev/null
+source "$HOME/.bashrc"
+# shellcheck source=/dev/null
+if [ -f "$HOME/.nvm/nvm.sh" ]; then
+  source "$HOME"/.nvm/nvm.sh
+else
+  export PATH="$HOME/.npm-global/bin:$PATH"
+fi
+
+function ensure_command() {
+  command -v "$1" &> /dev/null || {
+    echo "Error: '$1' not found." >&2
+    exit 1
+  }
+}
+
+ensure_command amp
+echo "AMP version: $(amp --version)"
+
+dir="$SOURCEGRAPH_AMP_START_DIRECTORY"
+if [[ -d "$dir" ]]; then
+  echo "Using existing directory: $dir"
+else
+  echo "Creating directory: $dir"
+  mkdir -p "$dir"
+fi
+cd "$dir"
+
+if [ -n "$SOURCEGRAPH_AMP_API_KEY" ]; then
+  printf "sourcegraph_amp_api_key provided !\n"
+  export AMP_API_KEY=$SOURCEGRAPH_AMP_API_KEY
+else
+  printf "sourcegraph_amp_api_key not provided\n"
+fi
+
+if [ -n "${SOURCEGRAPH_AMP_TASK_PROMPT:-}" ]; then
+  printf "sourcegraph amp task prompt provided : $SOURCEGRAPH_AMP_TASK_PROMPT"
+  PROMPT="Every step of the way, report tasks to Coder with proper descriptions and statuses. Your task at hand: $SOURCEGRAPH_AMP_TASK_PROMPT"
+
+  # Pipe the prompt into amp, which will be run inside agentapi
+  agentapi server --term-width=67 --term-height=1190 -- bash -c "echo \"$PROMPT\" | amp"
+else
+  printf "No task prompt given.\n"
+  agentapi server --term-width=67 --term-height=1190 -- amp
+fi
@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Mock behavior of the AMP CLI
+if [[ "$1" == "--version" ]]; then
+  echo "AMP CLI mock version v1.0.0"
+  exit 0
+fi
+
+# Simulate AMP running in a loop for AgentAPI to connect
+set -e
+while true; do
+  echo "$(date) - AMP mock is running..."
+  sleep 15
+done