summaryrefslogtreecommitdiff
path: root/packages/server/src/tools/shell.md
diff options
context:
space:
mode:
authorOlcan <[email protected]>2025-04-28 08:17:52 -0700
committerGitHub <[email protected]>2025-04-28 08:17:52 -0700
commita8f679ccb55402215366cc86acfd5c221613b670 (patch)
treec93ca4903a9d90473d070a76573dbe0394cda65b /packages/server/src/tools/shell.md
parenta9dc2772dda8d6c814a8f151aeb1e4e796a797d7 (diff)
shell tool tweaks (#194)
Diffstat (limited to 'packages/server/src/tools/shell.md')
-rw-r--r--packages/server/src/tools/shell.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/packages/server/src/tools/shell.md b/packages/server/src/tools/shell.md
index 4427ef95..a8a42381 100644
--- a/packages/server/src/tools/shell.md
+++ b/packages/server/src/tools/shell.md
@@ -1,8 +1,11 @@
-This is a minimal shell tool that executes a given command as `bash -c <command>`.
+This tool executes a given shell command as `bash -c <command>`.
Command can be any valid single-line Bash command.
+Command can start background processes using `&`.
+
The following information is returned:
-Command: Given command.
+Command: Executed command.
+Directory: Directory (relative to project root) where command was executed, or `(root)`.
Stdout: Output on stdout stream. Can be `(empty)` or partial on error.
Stderr: Output on stderr stream. Can be `(empty)` or partial on error.
Error: Error or `(none)` if no error occurred.