git.iko.soy/crush
on e00a70a help sign in
crush/internal/shell/doc.go
30 lines 815 B history raw
1package shell
3// Example usage of the shell package:
4//
5// 1. For one-off commands:
6//
7// shell := shell.NewShell(nil)
8// stdout, stderr, err := shell.Exec(context.Background(), "echo hello")
9//
10// 2. For maintaining state across commands:
11//
12// shell := shell.NewShell(&shell.Options{
13// WorkingDir: "/tmp",
14// Logger: myLogger,
15// })
16// shell.Exec(ctx, "export FOO=bar")
17// shell.Exec(ctx, "echo $FOO") // Will print "bar"
18//
19// 3. For the singleton persistent shell (used by tools):
20//
21// shell := shell.GetPersistentShell("/path/to/cwd")
22// stdout, stderr, err := shell.Exec(ctx, "ls -la")
23//
24// 4. Managing environment and working directory:
25//
26// shell := shell.NewShell(nil)
27// shell.SetEnv("MY_VAR", "value")
28// shell.SetWorkingDir("/tmp")
29// cwd := shell.GetWorkingDir()
30// env := shell.GetEnv()