clarify the why of ModifyCommand

johnstcn · johnstcn · commit f4c0eaba7b26 · 2025-02-25T15:37:26.000Z
diff --git a/agent/agentssh/agentssh.go b/agent/agentssh/agentssh.go
@@ -763,7 +763,9 @@ func (s *Server) CreateCommand(ctx context.Context, script string, env []string,
 		}
 	}
 
-	// Modify command prior to execution. This will usually be a no-op, but not always.
+	// Modify command prior to execution. This will usually be a no-op, but not
+	// always. For example, to run a command in a Docker container, we need to
+	// modify the command to be `docker exec -it <container> <command>`.
 	modifiedName, modifiedArgs := ei.ModifyCommand(name, args...)
 	// Log if the command was modified.
 	if modifiedName != name && slices.Compare(modifiedArgs, args) != 0 {

Original file line number	Diff line number	Diff line change
`@@ -763,7 +763,9 @@ func (s *Server) CreateCommand(ctx context.Context, script string, env []string,`
`763`	`763`	`}`
`764`	`764`	`}`
`765`	`765`
`766`		`- // Modify command prior to execution. This will usually be a no-op, but not always.`
	`766`	`+ // Modify command prior to execution. This will usually be a no-op, but not`
	`767`	`+ // always. For example, to run a command in a Docker container, we need to`
	`768`	+ // modify the command to be `docker exec -it <container> <command>`.
`767`	`769`	`modifiedName, modifiedArgs := ei.ModifyCommand(name, args...)`
`768`	`770`	`// Log if the command was modified.`
`769`	`771`	`if modifiedName != name && slices.Compare(modifiedArgs, args) != 0 {`