Back to Eliza

Coding Tools Plugin

packages/docs/plugin-registry/coding-tools.md

2.0.32.3 KB
Original Source

@elizaos/plugin-coding-tools provides filesystem, shell, and search primitives for Eliza agents: READ, WRITE, EDIT, NOTEBOOK_EDIT, BASH (with background TASK_OUTPUT / TASK_STOP), GREP, GLOB, LS, WEB_FETCH, WEB_SEARCH, TODO_WRITE, ASK_USER_QUESTION, ENTER_WORKTREE, and EXIT_WORKTREE. Paths must be absolute; operations are confined to configured workspace roots.

Package: @elizaos/plugin-coding-tools

Overview

The plugin registers sandbox-oriented services (FileStateService, SandboxService, SessionCwdService, RipgrepService, ShellTaskService, BashAstService, OsSandboxService), an AVAILABLE_CODING_TOOLS provider, and the actions listed above. On unsupported platforms or when disabled, actions can be gated off entirely.

Installation

bash
eliza plugins install coding-tools

The plugin is included in the agent core plugin list (CORE_PLUGINS); install via CLI when adding it to a minimal or custom runtime layout.

Disable

Set CODING_TOOLS_DISABLE to disable every action while the plugin remains loaded.

Configuration

VariableTypeRequiredDescription
CODING_TOOLS_WORKSPACE_ROOTSstringNoComma-separated absolute paths the tools may access; defaults when unset follow runtime/workspace resolution
CODING_TOOLS_DENY_COMMANDSstringNoExtra comma-separated command-prefix patterns BASH must refuse (merged with built-in deny rules)
CODING_TOOLS_BASH_TIMEOUT_MSnumberNoDefault BASH timeout (ms); hard ceiling before backgrounding rules apply
CODING_TOOLS_BASH_BG_BUDGET_MSnumberNoForeground budget (ms); longer runs return a task_id for TASK_OUTPUT
CODING_TOOLS_MAX_READ_LINESnumberNoMax lines READ returns in one call before truncation
CODING_TOOLS_MAX_FILE_SIZE_BYTESnumberNoPre-stat size cap for READ
CODING_TOOLS_GREP_HEAD_LIMITnumberNoDefault match cap for GREP (0 disables the limit)
CODING_TOOLS_DISABLEbooleanNoDisable all plugin actions
  • CLI Plugin — Command registration and interactive terminal sessions
  • MCP Plugin — Connect to external MCP servers for extended tooling