better-edit-tools Documentation on better-edit-tools 文档

CLI Usage

Mon, 01 Jan 0001 00:00:00 +0000

CLI Usage#

In addition to running as an MCP server, better-edit-tools exposes 8 core editing tools as CLI subcommands. This is useful for shell scripts, Pi Agent, or any workflow that prefers command-line invocation.

Basic usage#

better-edit-tools <command> [options]

Running without a subcommand starts the MCP server over stdio.

Subcommands#

File operations#

read: Read a line range from a file.
replace: Replace a line range.
insert: Insert content after a line.
delete: Delete a line range.
write: Write or overwrite a file.

Content recognition#

balance: Check pairing of brackets, quotes, and tags.
func-range: Detect the function or {} block range for a line.
tag-range: Detect the XML/HTML/Vue tag range for a line.

Common examples#

# Read lines 1-10
better-edit-tools read --file main.go --start 1 --end 10 --output json

# Replace a range
better-edit-tools replace --file main.go --start 5 --end 10 --content "..."

# Insert after line 4
better-edit-tools insert --file main.go --after-line 4 --content "..."

# Delete a range
better-edit-tools delete --file main.go --start 5 --end 10

# Write a file
better-edit-tools write --file main.go --content "package main\n"

# Balance / range detection
better-edit-tools balance --file main.go
better-edit-tools func-range --file main.go --line 12
better-edit-tools tag-range --file index.html --line 8

Pipe and stdin support#

To avoid shell quoting issues, some commands support --content-file and --old-file. Set the path to - to read from stdin.

LLM Self-Setup Guide

Mon, 01 Jan 0001 00:00:00 +0000

LLM Self-Setup Guide#

This guide is written for AI agents (Kimi Code, Claude Code, Cline, etc.) that need to make the better-edit-tools binary available on the user’s machine.

Goal#

Download the correct release binary, verify it, place it in a stable location, and report the absolute path back to the user or to the calling MCP client configuration step.

Do not modify the user’s MCP client configuration file unless the user explicitly asks you to. Your job is to get the binary installed and verified.

Go API Reference

Mon, 01 Jan 0001 00:00:00 +0000

betools — Go API Reference#

Package#

import "github.com/conglinyizhi/better-edit-tools-mcp/pkg/betools"

betools is the core editing library extracted from better-edit-tools, designed to be embedded directly in Go agent frameworks. It provides read, replace, insert, delete, write, function-range detection, and tag-range detection primitives — all write operations are protected by atomic file writes (temp file + rename).

Minimum Go version: Go 1.26+

Public Functions#

File Operations#

`Read`#

func Read(path string, start int, endLine int, brief bool, opts ...Option) (ShowResult, string, error)

Reads a line range from a file. Returns the content and a viewed_code_id (second return value) that can be passed to Replace for line-number validation.

Mon, 01 Jan 0001 00:00:00 +0000

Chip Mechanism Design Decisions#

1. Motivation#

In the MCP (Model Context Protocol) call chain, tool parameters generated by LLMs often fail due to JSON escaping issues, missing fields, or malformed formatting. Once a failure occurs, the original parameter content may only appear in a one-off error response, making it difficult for the model to reproduce the exact same content in subsequent rounds — especially for large code writes (be-write) or multi-line replacements.

better-edit-tools Documentation on better-edit-tools 文档

CLI Usage

CLI Usage#

Basic usage#

Subcommands#

File operations#

Content recognition#

Common examples#

Pipe and stdin support#

LLM Self-Setup Guide

LLM Self-Setup Guide#

Goal#

Go API Reference

betools — Go API Reference#

Package#

Public Functions#

File Operations#

Read#

Chip Mechanism Design Decisions#

1. Motivation#

`Read`#