typescript-virtual-container 1.2.5 → 1.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (245) hide show
  1. package/README.md +387 -193
  2. package/benchmark-results.txt +21 -21
  3. package/dist/SSHMimic/exec.js +2 -2
  4. package/dist/SSHMimic/executor.d.ts +6 -7
  5. package/dist/SSHMimic/executor.d.ts.map +1 -1
  6. package/dist/SSHMimic/executor.js +77 -60
  7. package/dist/SSHMimic/index.d.ts.map +1 -1
  8. package/dist/SSHMimic/index.js +6 -20
  9. package/dist/SSHMimic/sftp.d.ts.map +1 -1
  10. package/dist/SSHMimic/sftp.js +14 -0
  11. package/dist/VirtualFileSystem/index.d.ts.map +1 -1
  12. package/dist/VirtualFileSystem/index.js +13 -36
  13. package/dist/VirtualShell/shell.d.ts.map +1 -1
  14. package/dist/VirtualShell/shell.js +19 -2
  15. package/dist/VirtualShell/shellParser.d.ts +20 -2
  16. package/dist/VirtualShell/shellParser.d.ts.map +1 -1
  17. package/dist/VirtualShell/shellParser.js +229 -120
  18. package/dist/VirtualUserManager/index.d.ts.map +1 -1
  19. package/dist/commands/adduser.d.ts.map +1 -1
  20. package/dist/commands/adduser.js +2 -0
  21. package/dist/commands/awk.d.ts +3 -0
  22. package/dist/commands/awk.d.ts.map +1 -0
  23. package/dist/commands/awk.js +29 -0
  24. package/dist/commands/base64.d.ts +3 -0
  25. package/dist/commands/base64.d.ts.map +1 -0
  26. package/dist/commands/base64.js +20 -0
  27. package/dist/commands/cat.d.ts.map +1 -1
  28. package/dist/commands/cat.js +2 -0
  29. package/dist/commands/cd.d.ts.map +1 -1
  30. package/dist/commands/cd.js +2 -0
  31. package/dist/commands/chmod.d.ts.map +1 -1
  32. package/dist/commands/chmod.js +2 -0
  33. package/dist/commands/clear.d.ts.map +1 -1
  34. package/dist/commands/clear.js +4 -1
  35. package/dist/commands/cp.d.ts.map +1 -1
  36. package/dist/commands/cp.js +2 -0
  37. package/dist/commands/curl.d.ts.map +1 -1
  38. package/dist/commands/curl.js +2 -0
  39. package/dist/commands/cut.d.ts +3 -0
  40. package/dist/commands/cut.d.ts.map +1 -0
  41. package/dist/commands/cut.js +27 -0
  42. package/dist/commands/date.d.ts +3 -0
  43. package/dist/commands/date.d.ts.map +1 -0
  44. package/dist/commands/date.js +22 -0
  45. package/dist/commands/deluser.d.ts.map +1 -1
  46. package/dist/commands/deluser.js +2 -0
  47. package/dist/commands/df.d.ts +3 -0
  48. package/dist/commands/df.d.ts.map +1 -0
  49. package/dist/commands/df.js +16 -0
  50. package/dist/commands/diff.d.ts +3 -0
  51. package/dist/commands/diff.d.ts.map +1 -0
  52. package/dist/commands/diff.js +40 -0
  53. package/dist/commands/du.d.ts +3 -0
  54. package/dist/commands/du.d.ts.map +1 -0
  55. package/dist/commands/du.js +39 -0
  56. package/dist/commands/echo.d.ts.map +1 -1
  57. package/dist/commands/echo.js +2 -0
  58. package/dist/commands/env.d.ts.map +1 -1
  59. package/dist/commands/env.js +6 -14
  60. package/dist/commands/export.d.ts.map +1 -1
  61. package/dist/commands/export.js +11 -21
  62. package/dist/commands/find.d.ts.map +1 -1
  63. package/dist/commands/find.js +2 -0
  64. package/dist/commands/grep.d.ts.map +1 -1
  65. package/dist/commands/grep.js +4 -7
  66. package/dist/commands/groups.d.ts +3 -0
  67. package/dist/commands/groups.d.ts.map +1 -0
  68. package/dist/commands/groups.js +12 -0
  69. package/dist/commands/gzip.d.ts +4 -0
  70. package/dist/commands/gzip.d.ts.map +1 -0
  71. package/dist/commands/gzip.js +40 -0
  72. package/dist/commands/head.d.ts.map +1 -1
  73. package/dist/commands/head.js +2 -0
  74. package/dist/commands/help.d.ts +1 -1
  75. package/dist/commands/help.d.ts.map +1 -1
  76. package/dist/commands/help.js +75 -3
  77. package/dist/commands/hostname.d.ts.map +1 -1
  78. package/dist/commands/hostname.js +2 -0
  79. package/dist/commands/htop.d.ts.map +1 -1
  80. package/dist/commands/htop.js +2 -0
  81. package/dist/commands/id.d.ts +3 -0
  82. package/dist/commands/id.d.ts.map +1 -0
  83. package/dist/commands/id.js +14 -0
  84. package/dist/commands/index.d.ts +5 -2
  85. package/dist/commands/index.d.ts.map +1 -1
  86. package/dist/commands/index.js +89 -62
  87. package/dist/commands/kill.d.ts +3 -0
  88. package/dist/commands/kill.d.ts.map +1 -0
  89. package/dist/commands/kill.js +13 -0
  90. package/dist/commands/ln.d.ts.map +1 -1
  91. package/dist/commands/ln.js +2 -0
  92. package/dist/commands/ls.d.ts.map +1 -1
  93. package/dist/commands/ls.js +2 -0
  94. package/dist/commands/mkdir.d.ts.map +1 -1
  95. package/dist/commands/mkdir.js +2 -0
  96. package/dist/commands/mv.d.ts.map +1 -1
  97. package/dist/commands/mv.js +2 -0
  98. package/dist/commands/nano.d.ts.map +1 -1
  99. package/dist/commands/nano.js +2 -0
  100. package/dist/commands/neofetch.d.ts.map +1 -1
  101. package/dist/commands/neofetch.js +2 -0
  102. package/dist/commands/passwd.d.ts.map +1 -1
  103. package/dist/commands/passwd.js +2 -0
  104. package/dist/commands/ping.d.ts +3 -0
  105. package/dist/commands/ping.d.ts.map +1 -0
  106. package/dist/commands/ping.js +18 -0
  107. package/dist/commands/ps.d.ts +3 -0
  108. package/dist/commands/ps.d.ts.map +1 -0
  109. package/dist/commands/ps.js +17 -0
  110. package/dist/commands/pwd.d.ts.map +1 -1
  111. package/dist/commands/pwd.js +2 -0
  112. package/dist/commands/rm.d.ts.map +1 -1
  113. package/dist/commands/rm.js +2 -0
  114. package/dist/commands/sed.d.ts +3 -0
  115. package/dist/commands/sed.d.ts.map +1 -0
  116. package/dist/commands/sed.js +47 -0
  117. package/dist/commands/set.d.ts +3 -0
  118. package/dist/commands/set.d.ts.map +1 -1
  119. package/dist/commands/set.js +19 -46
  120. package/dist/commands/sh.d.ts +0 -1
  121. package/dist/commands/sh.d.ts.map +1 -1
  122. package/dist/commands/sh.js +228 -35
  123. package/dist/commands/sleep.d.ts +3 -0
  124. package/dist/commands/sleep.d.ts.map +1 -0
  125. package/dist/commands/sleep.js +13 -0
  126. package/dist/commands/sort.d.ts +3 -0
  127. package/dist/commands/sort.d.ts.map +1 -0
  128. package/dist/commands/sort.js +37 -0
  129. package/dist/commands/su.d.ts.map +1 -1
  130. package/dist/commands/su.js +2 -0
  131. package/dist/commands/sudo.d.ts.map +1 -1
  132. package/dist/commands/sudo.js +2 -0
  133. package/dist/commands/tail.d.ts.map +1 -1
  134. package/dist/commands/tail.js +2 -0
  135. package/dist/commands/tar.d.ts +3 -0
  136. package/dist/commands/tar.d.ts.map +1 -0
  137. package/dist/commands/tar.js +64 -0
  138. package/dist/commands/tee.d.ts +3 -0
  139. package/dist/commands/tee.d.ts.map +1 -0
  140. package/dist/commands/tee.js +29 -0
  141. package/dist/commands/touch.d.ts.map +1 -1
  142. package/dist/commands/touch.js +2 -0
  143. package/dist/commands/tr.d.ts +3 -0
  144. package/dist/commands/tr.d.ts.map +1 -0
  145. package/dist/commands/tr.js +24 -0
  146. package/dist/commands/tree.d.ts.map +1 -1
  147. package/dist/commands/tree.js +2 -0
  148. package/dist/commands/uname.d.ts +3 -0
  149. package/dist/commands/uname.d.ts.map +1 -0
  150. package/dist/commands/uname.js +21 -0
  151. package/dist/commands/uniq.d.ts +3 -0
  152. package/dist/commands/uniq.d.ts.map +1 -0
  153. package/dist/commands/uniq.js +33 -0
  154. package/dist/commands/unset.d.ts.map +1 -1
  155. package/dist/commands/unset.js +6 -10
  156. package/dist/commands/wc.d.ts.map +1 -1
  157. package/dist/commands/wc.js +2 -0
  158. package/dist/commands/wget.d.ts.map +1 -1
  159. package/dist/commands/wget.js +2 -0
  160. package/dist/commands/who.d.ts.map +1 -1
  161. package/dist/commands/who.js +2 -0
  162. package/dist/commands/whoami.d.ts.map +1 -1
  163. package/dist/commands/whoami.js +2 -0
  164. package/dist/commands/xargs.d.ts +3 -0
  165. package/dist/commands/xargs.d.ts.map +1 -0
  166. package/dist/commands/xargs.js +16 -0
  167. package/dist/types/commands.d.ts +13 -0
  168. package/dist/types/commands.d.ts.map +1 -1
  169. package/dist/types/pipeline.d.ts +20 -0
  170. package/dist/types/pipeline.d.ts.map +1 -1
  171. package/package.json +1 -1
  172. package/src/SSHMimic/exec.ts +2 -2
  173. package/src/SSHMimic/executor.ts +95 -98
  174. package/src/SSHMimic/index.ts +15 -49
  175. package/src/SSHMimic/sftp.ts +15 -0
  176. package/src/VirtualFileSystem/index.ts +27 -75
  177. package/src/VirtualShell/shell.ts +19 -2
  178. package/src/VirtualShell/shellParser.ts +202 -168
  179. package/src/VirtualUserManager/index.ts +2 -7
  180. package/src/commands/adduser.ts +2 -0
  181. package/src/commands/awk.ts +30 -0
  182. package/src/commands/base64.ts +18 -0
  183. package/src/commands/cat.ts +2 -0
  184. package/src/commands/cd.ts +2 -0
  185. package/src/commands/chmod.ts +2 -0
  186. package/src/commands/clear.ts +4 -1
  187. package/src/commands/cp.ts +2 -0
  188. package/src/commands/curl.ts +2 -0
  189. package/src/commands/cut.ts +29 -0
  190. package/src/commands/date.ts +24 -0
  191. package/src/commands/deluser.ts +2 -0
  192. package/src/commands/df.ts +18 -0
  193. package/src/commands/diff.ts +29 -0
  194. package/src/commands/du.ts +39 -0
  195. package/src/commands/echo.ts +2 -0
  196. package/src/commands/env.ts +6 -16
  197. package/src/commands/export.ts +11 -24
  198. package/src/commands/find.ts +2 -0
  199. package/src/commands/grep.ts +4 -7
  200. package/src/commands/groups.ts +14 -0
  201. package/src/commands/gzip.ts +31 -0
  202. package/src/commands/head.ts +2 -0
  203. package/src/commands/help.ts +81 -3
  204. package/src/commands/hostname.ts +2 -0
  205. package/src/commands/htop.ts +2 -0
  206. package/src/commands/id.ts +16 -0
  207. package/src/commands/index.ts +98 -99
  208. package/src/commands/kill.ts +14 -0
  209. package/src/commands/ln.ts +2 -0
  210. package/src/commands/ls.ts +2 -0
  211. package/src/commands/mkdir.ts +2 -0
  212. package/src/commands/mv.ts +2 -0
  213. package/src/commands/nano.ts +2 -0
  214. package/src/commands/neofetch.ts +2 -0
  215. package/src/commands/passwd.ts +2 -0
  216. package/src/commands/ping.ts +20 -0
  217. package/src/commands/ps.ts +19 -0
  218. package/src/commands/pwd.ts +2 -0
  219. package/src/commands/rm.ts +2 -0
  220. package/src/commands/sed.ts +45 -0
  221. package/src/commands/set.ts +19 -50
  222. package/src/commands/sh.ts +192 -43
  223. package/src/commands/sleep.ts +14 -0
  224. package/src/commands/sort.ts +37 -0
  225. package/src/commands/su.ts +2 -0
  226. package/src/commands/sudo.ts +2 -0
  227. package/src/commands/tail.ts +2 -0
  228. package/src/commands/tar.ts +58 -0
  229. package/src/commands/tee.ts +25 -0
  230. package/src/commands/touch.ts +2 -0
  231. package/src/commands/tr.ts +24 -0
  232. package/src/commands/tree.ts +2 -0
  233. package/src/commands/uname.ts +20 -0
  234. package/src/commands/uniq.ts +28 -0
  235. package/src/commands/unset.ts +5 -12
  236. package/src/commands/wc.ts +2 -0
  237. package/src/commands/wget.ts +2 -0
  238. package/src/commands/who.ts +2 -0
  239. package/src/commands/whoami.ts +2 -0
  240. package/src/commands/xargs.ts +17 -0
  241. package/src/types/commands.ts +14 -0
  242. package/src/types/pipeline.ts +23 -0
  243. package/standalone.js +92 -64
  244. package/standalone.js.map +4 -4
  245. package/tests/users.test.ts +5 -34
@@ -0,0 +1,29 @@
1
+ import type { ShellModule } from "../types/commands";
2
+ import { resolvePath } from "./helpers";
3
+
4
+ export const diffCommand: ShellModule = {
5
+ name: "diff",
6
+ description: "Compare files line by line",
7
+ category: "text",
8
+ params: ["<file1> <file2>"],
9
+ run: ({ shell, cwd, args }) => {
10
+ const [f1, f2] = args;
11
+ if (!f1 || !f2) return { stderr: "diff: missing operand", exitCode: 1 };
12
+ const p1 = resolvePath(cwd, f1);
13
+ const p2 = resolvePath(cwd, f2);
14
+ let a: string[], b: string[];
15
+ try { a = shell.vfs.readFile(p1).split("\n"); } catch { return { stderr: `diff: ${f1}: No such file or directory`, exitCode: 2 }; }
16
+ try { b = shell.vfs.readFile(p2).split("\n"); } catch { return { stderr: `diff: ${f2}: No such file or directory`, exitCode: 2 }; }
17
+
18
+ const out: string[] = [];
19
+ const max = Math.max(a.length, b.length);
20
+ for (let i = 0; i < max; i++) {
21
+ const la = a[i]; const lb = b[i];
22
+ if (la !== lb) {
23
+ if (la !== undefined) out.push(`< ${la}`);
24
+ if (lb !== undefined) out.push(`> ${lb}`);
25
+ }
26
+ }
27
+ return { stdout: out.join("\n"), exitCode: out.length > 0 ? 1 : 0 };
28
+ },
29
+ };
@@ -0,0 +1,39 @@
1
+ import type { ShellModule } from "../types/commands";
2
+ import { ifFlag } from "./command-helpers";
3
+ import { resolvePath } from "./helpers";
4
+
5
+ export const duCommand: ShellModule = {
6
+ name: "du",
7
+ description: "Estimate file space usage",
8
+ category: "system",
9
+ params: ["[-h] [-s] [path]"],
10
+ run: ({ shell, cwd, args }) => {
11
+ const human = ifFlag(args, ["-h"]);
12
+ const summary = ifFlag(args, ["-s"]);
13
+ const target = args.find((a) => !a.startsWith("-")) ?? ".";
14
+ const p = resolvePath(cwd, target);
15
+
16
+ const fmt = (b: number) => human ? `${(b / 1024).toFixed(1)}K` : String(Math.ceil(b / 1024));
17
+
18
+ if (!shell.vfs.exists(p)) return { stderr: `du: ${target}: No such file or directory`, exitCode: 1 };
19
+
20
+ if (summary || shell.vfs.stat(p).type === "file") {
21
+ return { stdout: `${fmt(shell.vfs.getUsageBytes(p))}\t${target}`, exitCode: 0 };
22
+ }
23
+
24
+ const lines: string[] = [];
25
+ const walk = (dir: string, rel: string) => {
26
+ let total = 0;
27
+ for (const e of shell.vfs.list(dir)) {
28
+ const full = `${dir}/${e}`, r = `${rel}/${e}`;
29
+ const st = shell.vfs.stat(full);
30
+ if (st.type === "directory") total += walk(full, r);
31
+ else { total += st.size; if (!summary) lines.push(`${fmt(st.size)}\t${r}`); }
32
+ }
33
+ lines.push(`${fmt(total)}\t${rel}`);
34
+ return total;
35
+ };
36
+ walk(p, target);
37
+ return { stdout: lines.join("\n"), exitCode: 0 };
38
+ },
39
+ };
@@ -10,6 +10,8 @@ function expandEnvVars(input: string, env: Record<string, string>): string {
10
10
 
11
11
  export const echoCommand: ShellModule = {
12
12
  name: "echo",
13
+ description: "Display text",
14
+ category: "shell",
13
15
  params: ["[options] [text...]"],
14
16
  run: ({ args, authUser, stdin }) => {
15
17
  const { flags, positionals } = parseArgs(args, { flags: ["-n"] });
@@ -1,22 +1,12 @@
1
1
  import type { ShellModule } from "../types/commands";
2
- import { getAllEnvVars } from "./set";
3
2
 
4
3
  export const envCommand: ShellModule = {
5
4
  name: "env",
6
- params: ["[VAR=value...] [command]"],
7
- run: ({ authUser }) => {
8
- // For now, just display all environment variables
9
- // In a full implementation, this would also handle running commands with modified env
10
-
11
- const allVars = getAllEnvVars(authUser);
12
- const envVarsOutput = Object.entries(allVars)
13
- .map(([key, value]) => `${key}=${value}`)
14
- .sort()
15
- .join("\n");
16
-
17
- return {
18
- stdout: envVarsOutput,
19
- exitCode: 0,
20
- };
5
+ description: "Print environment variables",
6
+ category: "shell",
7
+ params: [],
8
+ run: ({ env, authUser }) => {
9
+ const vars = { ...env.vars, USER: authUser, HOME: `/home/${authUser}` };
10
+ return { stdout: Object.entries(vars).map(([k, v]) => `${k}=${v}`).join("\n"), exitCode: 0 };
21
11
  },
22
12
  };
@@ -1,38 +1,25 @@
1
1
  import type { ShellModule } from "../types/commands";
2
- import { getArg } from "./command-helpers";
3
- import { getEnvVar, setEnvVar } from "./set";
4
2
 
5
3
  export const exportCommand: ShellModule = {
6
4
  name: "export",
5
+ description: "Set shell environment variable",
6
+ category: "shell",
7
7
  params: ["[VAR=value]"],
8
- run: ({ args }) => {
9
- // export VAR=value or export VAR (to make it available to child processes)
8
+ run: ({ args, env }) => {
10
9
  if (args.length === 0) {
11
- // List all exported variables
12
- return {
13
- stdout: "# export command - sets variables for child processes",
14
- exitCode: 0,
15
- };
10
+ const out = Object.entries(env.vars).map(([k, v]) => `declare -x ${k}="${v}"`).join("\n");
11
+ return { stdout: out, exitCode: 0 };
16
12
  }
17
-
18
- // Parse VAR=value format
19
- for (let index = 0; ; index += 1) {
20
- const arg = getArg(args, index);
21
- if (!arg) {
22
- break;
23
- }
24
-
13
+ for (const arg of args) {
25
14
  if (arg.includes("=")) {
26
- const [varName, varValue] = arg.split("=", 2);
27
- if (varName && varValue !== undefined) {
28
- setEnvVar(varName, varValue);
29
- }
15
+ const eq = arg.indexOf("=");
16
+ const name = arg.slice(0, eq);
17
+ const value = arg.slice(eq + 1);
18
+ env.vars[name] = value;
30
19
  } else {
31
- // export VAR_NAME makes it available but we just set it
32
- setEnvVar(arg, getEnvVar(arg) || "");
20
+ // mark existing as exported (already is)
33
21
  }
34
22
  }
35
-
36
23
  return { exitCode: 0 };
37
24
  },
38
25
  };
@@ -4,6 +4,8 @@ import { assertPathAccess, resolvePath } from "./helpers";
4
4
 
5
5
  export const findCommand: ShellModule = {
6
6
  name: "find",
7
+ description: "Search for files",
8
+ category: "files",
7
9
  params: ["[path] [-name <pattern>] [-type f|d]"],
8
10
  run: ({ authUser, shell, cwd, args }) => {
9
11
  const namePattern = getFlag(args, ["-name"]);
@@ -4,11 +4,11 @@ import { assertPathAccess, resolvePath } from "./helpers";
4
4
 
5
5
  export const grepCommand: ShellModule = {
6
6
  name: "grep",
7
+ description: "Search text patterns",
8
+ category: "text",
7
9
  params: ["[-i] [-v] [-n] [-r] <pattern> [file...]"],
8
10
  run: ({ authUser, shell, cwd, args, stdin }) => {
9
- const { flags, positionals } = parseArgs(args, {
10
- flags: ["-i", "-v", "-n", "-r"],
11
- });
11
+ const { flags, positionals } = parseArgs(args, { flags: ["-i", "-v", "-n", "-r"] });
12
12
  const caseInsensitive = flags.has("-i");
13
13
  const invertMatch = flags.has("-v");
14
14
  const showLineNumbers = flags.has("-n");
@@ -80,10 +80,7 @@ export const grepCommand: ShellModule = {
80
80
  const prefix = resolvedPaths.length > 1 ? `${file}:` : "";
81
81
  results.push(...matchLines(content, prefix));
82
82
  } catch {
83
- return {
84
- stderr: `grep: ${file}: No such file or directory`,
85
- exitCode: 1,
86
- };
83
+ return { stderr: `grep: ${file}: No such file or directory`, exitCode: 1 };
87
84
  }
88
85
  }
89
86
  }
@@ -0,0 +1,14 @@
1
+ import type { ShellModule } from "../types/commands";
2
+
3
+ export const groupsCommand: ShellModule = {
4
+ name: "groups",
5
+ description: "Print group memberships",
6
+ category: "system",
7
+ params: ["[user]"],
8
+ run: ({ authUser, shell, args }) => {
9
+ const target = args[0] ?? authUser;
10
+ const isSudo = shell.users.isSudoer(target);
11
+ const grps = isSudo ? `${target} sudo root` : target;
12
+ return { stdout: grps, exitCode: 0 };
13
+ },
14
+ };
@@ -0,0 +1,31 @@
1
+ import type { ShellModule } from "../types/commands";
2
+ import { resolvePath } from "./helpers";
3
+
4
+ export const gzipCommand: ShellModule = {
5
+ name: "gzip",
6
+ description: "Compress files",
7
+ category: "archive",
8
+ params: ["<file>"],
9
+ run: ({ shell, cwd, args }) => {
10
+ const file = args[0];
11
+ if (!file) return { stderr: "gzip: no file specified", exitCode: 1 };
12
+ const p = resolvePath(cwd, file);
13
+ try { shell.vfs.compressFile(p); return { exitCode: 0 }; }
14
+ catch { return { stderr: `gzip: ${file}: No such file or directory`, exitCode: 1 }; }
15
+ },
16
+ };
17
+
18
+ export const gunzipCommand: ShellModule = {
19
+ name: "gunzip",
20
+ description: "Decompress files",
21
+ category: "archive",
22
+ params: ["<file>"],
23
+ aliases: ["zcat"],
24
+ run: ({ shell, cwd, args }) => {
25
+ const file = args[0];
26
+ if (!file) return { stderr: "gunzip: no file specified", exitCode: 1 };
27
+ const p = resolvePath(cwd, file);
28
+ try { shell.vfs.decompressFile(p); return { exitCode: 0 }; }
29
+ catch { return { stderr: `gunzip: ${file}: No such file or directory`, exitCode: 1 }; }
30
+ },
31
+ };
@@ -4,6 +4,8 @@ import { assertPathAccess, resolvePath } from "./helpers";
4
4
 
5
5
  export const headCommand: ShellModule = {
6
6
  name: "head",
7
+ description: "Output first lines",
8
+ category: "text",
7
9
  params: ["[-n <lines>] [file...]"],
8
10
  run: ({ authUser, shell, cwd, args, stdin }) => {
9
11
  const nArg = getFlag(args, ["-n"]);
@@ -1,9 +1,87 @@
1
1
  import type { ShellModule } from "../types/commands";
2
+ import { getCommandModulesPublic } from "./index";
2
3
 
3
- export function createHelpCommand(getNames: () => string[]): ShellModule {
4
+ const CATEGORY_ORDER = ["navigation", "files", "text", "archive", "system", "network", "shell", "users", "misc"];
5
+ const CATEGORY_LABELS: Record<string, string> = {
6
+ navigation: "Navigation",
7
+ files: "Files & Filesystem",
8
+ text: "Text Processing",
9
+ archive: "Archive & Compression",
10
+ system: "System",
11
+ network: "Network",
12
+ shell: "Shell",
13
+ users: "Users & Permissions",
14
+ misc: "Miscellaneous",
15
+ };
16
+
17
+ function padRight(s: string, n: number): string {
18
+ return s.length >= n ? s : s + " ".repeat(n - s.length);
19
+ }
20
+
21
+ export function createHelpCommand(_getNames: () => string[]): ShellModule {
4
22
  return {
5
23
  name: "help",
6
- params: [],
7
- run: () => ({ stdout: `Builtins: ${getNames().join(" ")}`, exitCode: 0 }),
24
+ description: "Display this help message",
25
+ category: "shell",
26
+ params: ["[command]"],
27
+ run: ({ args }) => {
28
+ const modules = getCommandModulesPublic();
29
+
30
+ // help <command>
31
+ if (args[0]) {
32
+ const mod = modules.find((m) => m.name === args[0] || m.aliases?.includes(args[0]!));
33
+ if (!mod) return { stderr: `help: no help for '${args[0]}'`, exitCode: 1 };
34
+ const aliases = mod.aliases?.length ? ` aliases: ${mod.aliases.join(", ")}\n` : "";
35
+ const params = mod.params.map((p) => ` ${mod.name} ${p}`).join("\n");
36
+ return {
37
+ stdout: [
38
+ `\x1b[1m${mod.name}\x1b[0m — ${mod.description ?? "no description"}`,
39
+ aliases,
40
+ "Usage:",
41
+ params || ` ${mod.name}`,
42
+ ].filter(Boolean).join("\n"),
43
+ exitCode: 0,
44
+ };
45
+ }
46
+
47
+ // Full help — grouped by category
48
+ const grouped: Record<string, ShellModule[]> = {};
49
+ for (const mod of modules) {
50
+ const cat = mod.category ?? "misc";
51
+ if (!grouped[cat]) grouped[cat] = [];
52
+ grouped[cat]!.push(mod);
53
+ }
54
+
55
+ const lines: string[] = [];
56
+ lines.push("\x1b[1mAvailable commands\x1b[0m");
57
+ lines.push("");
58
+
59
+ const cats = [
60
+ ...CATEGORY_ORDER.filter((c) => grouped[c]),
61
+ ...Object.keys(grouped).filter((c) => !CATEGORY_ORDER.includes(c)),
62
+ ];
63
+
64
+ for (const cat of cats) {
65
+ const mods = grouped[cat];
66
+ if (!mods || mods.length === 0) continue;
67
+ lines.push(`\x1b[33m${CATEGORY_LABELS[cat] ?? cat}\x1b[0m`);
68
+
69
+ // Two-column layout
70
+ const sorted = [...mods].sort((a, b) => a.name.localeCompare(b.name));
71
+ for (let i = 0; i < sorted.length; i += 2) {
72
+ const left = sorted[i]!;
73
+ const right = sorted[i + 1];
74
+ const leftStr = ` \x1b[36m${padRight(left.name, 14)}\x1b[0m ${left.description ?? ""}`;
75
+ const rightStr = right
76
+ ? ` \x1b[36m${padRight(right.name, 14)}\x1b[0m ${right.description ?? ""}`
77
+ : "";
78
+ lines.push(rightStr ? `${leftStr.padEnd(44)}${rightStr}` : leftStr);
79
+ }
80
+ lines.push("");
81
+ }
82
+
83
+ lines.push("Type \x1b[1mhelp <command>\x1b[0m for usage details.");
84
+ return { stdout: lines.join("\n"), exitCode: 0 };
85
+ },
8
86
  };
9
87
  }
@@ -2,6 +2,8 @@ import type { ShellModule } from "../types/commands";
2
2
 
3
3
  export const hostnameCommand: ShellModule = {
4
4
  name: "hostname",
5
+ description: "Print hostname",
6
+ category: "system",
5
7
  params: [],
6
8
  run: ({ hostname }) => ({ stdout: hostname, exitCode: 0 }),
7
9
  };
@@ -2,6 +2,8 @@ import type { ShellModule } from "../types/commands";
2
2
 
3
3
  export const htopCommand: ShellModule = {
4
4
  name: "htop",
5
+ description: "System monitor",
6
+ category: "system",
5
7
  params: [],
6
8
  run: ({ mode }) => {
7
9
  if (mode === "exec") {
@@ -0,0 +1,16 @@
1
+ import type { ShellModule } from "../types/commands";
2
+
3
+ export const idCommand: ShellModule = {
4
+ name: "id",
5
+ description: "Print user identity",
6
+ category: "system",
7
+ params: ["[user]"],
8
+ run: ({ authUser, shell, args }) => {
9
+ const target = args[0] ?? authUser;
10
+ const uid = target === "root" ? 0 : 1000;
11
+ const gid = uid;
12
+ const isSudo = shell.users.isSudoer(target);
13
+ const groups = isSudo ? `${gid}(${target}),0(root)` : `${gid}(${target})`;
14
+ return { stdout: `uid=${uid}(${target}) gid=${gid}(${target}) groups=${groups}`, exitCode: 0 };
15
+ },
16
+ };