You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 23, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: packages/jumpstarter-driver-shell/README.md
+50Lines changed: 50 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,3 +63,53 @@ methods will be generated dynamically, and they will be available as follows:
63
63
64
64
:returns: A tuple(stdout, stderr, return_code)
65
65
```
66
+
67
+
## CLI Usage
68
+
69
+
The shell driver also provides a CLI when using `jmp shell`. All configured methods become available as CLI commands, except for methods starting with `_` which are considered private and hidden from the end user:
70
+
71
+
```console
72
+
$ jmp shell --exporter shell-exporter
73
+
$ j shell
74
+
Usage: j shell [OPTIONS] COMMAND [ARGS]...
75
+
76
+
Shell command executor
77
+
78
+
Commands:
79
+
env_var Execute the env_var shell method
80
+
ls Execute the ls shell method
81
+
method2 Execute the method2 shell method
82
+
method3 Execute the method3 shell method
83
+
```
84
+
85
+
### CLI Command Usage
86
+
87
+
Each configured method becomes a CLI command with the following options:
88
+
89
+
```console
90
+
$ j shell ls --help
91
+
Usage: j shell ls [OPTIONS] [ARGS]...
92
+
93
+
Execute the ls shell method
94
+
95
+
Options:
96
+
-e, --env TEXT Environment variables in KEY=VALUE format
0 commit comments