Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
display_name: Agent Helper
display_name: Coder Utils
description: Building block for modules that need orchestrated script execution
icon: ../../../../.icons/coder.svg
verified: false
tags: [internal, library]
---

# Agent Helper
# Coder Utils

> [!CAUTION]
> We do not recommend using this module directly. It is intended primarily for internal use by Coder to create modules with orchestrated script execution.

The Agent Helper module is a building block for modules that need to run multiple scripts in a specific order. It uses `coder exp sync` for dependency management and is designed for orchestrating pre-install, install, post-install, and start scripts.
The Coder Utils module is a building block for modules that need to run multiple scripts in a specific order. It uses `coder exp sync` for dependency management and is designed for orchestrating pre-install, install, post-install, and start scripts.

> [!NOTE]
>
> - The `agent_name` should be the same as that of the agentapi module's `agent_name` if used together.

```tf
module "agent_helper" {
source = "registry.coder.com/coder/agent-helper/coder"
module "coder_helper" {
source = "registry.coder.com/coder/coder-utils/coder"
version = "1.0.0"

agent_id = coder_agent.main.id
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { describe } from "bun:test";
import { runTerraformInit, testRequiredVariables } from "~test";

describe("agent-helper", async () => {
describe("coder-utils", async () => {
await runTerraformInit(import.meta.dir);

testRequiredVariables(import.meta.dir, {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Test for agent-helper module
# Test for coder-utils module

# Test with all scripts provided
run "test_with_all_scripts" {
Expand Down
Loading