shell

func (*Shell) ActionAllowed ¶

func (s *Shell) ActionAllowed(a cmds.Action) bool

ActionAllowed reports whether the session may perform the capability class. An unrestricted shell (allowedActions == nil) permits everything.

func (*Shell) AllEnv ¶

func (s *Shell) AllEnv() map[string]string

func (*Shell) Cwd ¶

func (s *Shell) Cwd() string

func (*Shell) DeleteEnv ¶

func (s *Shell) DeleteEnv(key string)

func (*Shell) Docsets ¶

func (s *Shell) Docsets() []cmds.DocsetInfo

Docsets reports the per-session docset views. Implements CmdContext.

func (*Shell) Exec ¶

func (s *Shell) Exec(cmdLine string, w io.Writer, errW io.Writer, stdin io.Reader) int

Exec parses and executes a single command line.

func (*Shell) ExecPipeline ¶

func (s *Shell) ExecPipeline(line string, w io.Writer, errW io.Writer, stdin io.Reader) int

ExecPipeline parses a shell line and executes the resulting AST. stdin is optional — pass nil if no external stdin is available.

func (*Shell) FS ¶

func (s *Shell) FS() vfs.FileSystem

func (*Shell) GetEnv ¶

func (s *Shell) GetEnv(key string) string

func (*Shell) PublishTargets ¶

func (s *Shell) PublishTargets() []cmds.PublishTarget

PublishTargets reports the per-session publish inboxes. Implements CmdContext.

func (*Shell) Resolve ¶

func (s *Shell) Resolve(p string) string

func (*Shell) RunInteractive ¶

func (s *Shell) RunInteractive(rw io.ReadWriter, errW io.Writer, motd string, prompt string)

RunInteractive runs an interactive shell session. rw is used for both reading input and writing output. When running over an SSH session with an allocated PTY, the session's ptyWriter already converts \n to \r\n, so no additional CRLFWriter wrapping is needed.

func (*Shell) SetAllowedActions ¶

func (s *Shell) SetAllowedActions(actions []cmds.Action)

SetAllowedActions restricts the shell to the given capability classes (Part B). Passing nil (or not calling this) leaves the shell unrestricted. ActionRead is always implied so that read-only commands and introspection (help, ls, …) keep working.

func (*Shell) SetConflictPolicyFn ¶

func (s *Shell) SetConflictPolicyFn(fn func(resolvedPath string) vfs.WriteConflictPolicy)

SetConflictPolicyFn installs a resolver that maps a resolved path to its write-conflict policy. Passing nil restores the default (vfs.PolicyHash).

func (*Shell) SetCwd ¶

func (s *Shell) SetCwd(dir string)

func (*Shell) SetDocsets ¶

func (s *Shell) SetDocsets(d []cmds.DocsetInfo)

SetDocsets installs the per-session docset views surfaced by `lore docsets`.

func (*Shell) SetEnv ¶

func (s *Shell) SetEnv(key, value string)

func (*Shell) SetPublishTargets ¶

func (s *Shell) SetPublishTargets(t []cmds.PublishTarget)

SetPublishTargets installs the per-session publish inboxes used by `publish`.

func (*Shell) WriteConflictPolicy ¶

func (s *Shell) WriteConflictPolicy(resolvedPath string) vfs.WriteConflictPolicy

WriteConflictPolicy reports the policy for overwrites to resolvedPath. With no resolver installed it returns the default compare-and-swap policy.