summaryrefslogtreecommitdiff
path: root/packages/core/src/tools/shell.md
diff options
context:
space:
mode:
authorTommaso Sciortino <[email protected]>2025-05-30 18:25:47 -0700
committerGitHub <[email protected]>2025-05-30 18:25:47 -0700
commit21fba832d1b4ea7af43fb887d9b2b38fcf8210d0 (patch)
tree7200d2fac3a55c385e0a2dac34b5282c942364bc /packages/core/src/tools/shell.md
parentc81148a0cc8489f657901c2cc7247c0834075e1a (diff)
Rename server->core (#638)
Diffstat (limited to 'packages/core/src/tools/shell.md')
-rw-r--r--packages/core/src/tools/shell.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/packages/core/src/tools/shell.md b/packages/core/src/tools/shell.md
new file mode 100644
index 00000000..069a76db
--- /dev/null
+++ b/packages/core/src/tools/shell.md
@@ -0,0 +1,14 @@
+This tool executes a given shell command as `bash -c <command>`.
+Command can start background processes using `&`.
+Command itself is executed as a subprocess.
+
+The following information is returned:
+
+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 and for any unwaited background processes.
+Stderr: Output on stderr stream. Can be `(empty)` or partial on error and for any unwaited background processes.
+Error: Error or `(none)` if no error was reported for the subprocess.
+Exit Code: Exit code or `(none)` if terminated by signal.
+Signal: Signal number or `(none)` if no signal was received.
+Background PIDs: List of background processes started or `(none)`.