All Implemented Interfaces:

eu.jrie.jetbrains.kotlinshell.processes.execution.ExecutionContext , eu.jrie.jetbrains.kotlinshell.processes.execution.ProcessExecutionContext , eu.jrie.jetbrains.kotlinshell.shell.ShellBase , eu.jrie.jetbrains.kotlinshell.shell.ShellProcess , eu.jrie.jetbrains.kotlinshell.shell.ShellUtility , eu.jrie.jetbrains.kotlinshell.shell.piping.ShellForking , eu.jrie.jetbrains.kotlinshell.shell.piping.ShellPiping
```
@ExperimentalCoroutinesApi() 
public class Shell
 implements ShellForking, ShellPiping, ShellProcess, ShellUtility
                    
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Shell.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final ReceiveChannel<ByteReadPacket>`	`nullin`
`private final SendChannel<ByteReadPacket>`	`nullout`
`private final ReceiveChannel<ByteReadPacket>`	`stdin`
`private Map<String, String>`	`environment`
`private Map<String, String>`	`variables`
`private File`	`directory`
`private final List<Pair<Integer, Process>>`	`detachedProcesses`
`private final List<Process>`	`daemons`
`private final List<Pair<Integer, Pipeline>>`	`detachedPipelines`
`private final SuspendFunction1<ExecutionContext, Unit>`	`jobs`
`private final CoroutineScope`	`scope`
`private final ProcessCommander`	`commander`
`private final SendChannel<ByteReadPacket>`	`stdout`
`private final SendChannel<ByteReadPacket>`	`stderr`
`private final SuspendFunction1<ExecutionContext, Unit>`	`env`
`private final SuspendFunction1<ExecutionContext, Unit>`	`set`
`private final Map<String, String>`	`shellEnv`
`private final Map<String, String>`	`systemEnv`
`private final List<Process>`	`processes`
`private final SuspendFunction1<ExecutionContext, Unit>`	`ps`

Method Summary

Modifier and Type	Method	Description
`final ReceiveChannel<ByteReadPacket>`	`getNullin()`	Dummy input channel.
`final SendChannel<ByteReadPacket>`	`getNullout()`	Dummy output channel.
`final ReceiveChannel<ByteReadPacket>`	`getStdin()`
`final Map<String, String>`	`getEnvironment()`	Environment of this shell.
`final Unit`	`setEnvironment(Map<String, String> environment)`
`final Map<String, String>`	`getVariables()`	Variables of this shell.
`final Unit`	`setVariables(Map<String, String> variables)`
`final File`	`getDirectory()`	Current directory of this shell
`final Unit`	`setDirectory(File directory)`
`List<Pair<Integer, Process>>`	`getDetachedProcesses()`
`List<Process>`	`getDaemons()`
`List<Pair<Integer, Pipeline>>`	`getDetachedPipelines()`
`final SuspendFunction1<ExecutionContext, Unit>`	`getJobs()`
`final CoroutineScope`	`getScope()`	CoroutineScope used by this shell, its members and sub shells
`final ProcessCommander`	`getCommander()`
`final SendChannel<ByteReadPacket>`	`getStdout()`
`final SendChannel<ByteReadPacket>`	`getStderr()`
`SuspendFunction1<ExecutionContext, Unit>`	`getEnv()`
`SuspendFunction1<ExecutionContext, Unit>`	`getSet()`
`Map<String, String>`	`getShellEnv()`
`Map<String, String>`	`getSystemEnv()`
`List<Process>`	`getProcesses()`
`SuspendFunction1<ExecutionContext, Unit>`	`getPs()`
`File`	`cd(File dir)`	Changes directory to given dir
`Unit`	`variable(Pair<String, String> variable)`	Adds new shell variable
`Unit`	`variable(Readonly $self, Pair<String, String> variable)`
`Unit`	`export(Pair<String, String> env)`	Adds new environment variable
`Unit`	`export(Readonly $self, Pair<String, String> env)`
`Unit`	`unset(String key)`	Removes shell or environmental variable matching given key
`Process`	`detach(ProcessExecutable executable)`	Detaches process from the shell and executes it in the background
`Pipeline`	`detach(SuspendFunction1<AbstractPipingDSLShell, Pipeline> pipelineConfig)`	Creates new Pipeline specified by DSL pipelineConfig and executes it as detached job.
`Unit`	`joinDetached()`	Joins all detached processes
`final Unit`	`fg(Integer index)`	Attaches job with given index
`Unit`	`fg(Process process)`	Attaches selected Process
`Unit`	`fg(Pipeline pipeline)`	Attaches selected Pipeline
`Process`	`daemon(ProcessExecutable executable)`
`Unit`	`finalize()`
`final Unit`	`shell(Map<String, String> vars, File dir, SuspendFunction1<Shell, Unit> script)`
`Pipeline`	`pipeline(ExecutionMode mode, SuspendFunction1<AbstractPipingDSLShell, Pipeline> pipelineConfig)`	Creates and executes new Pipeline specified by DSL pipelineConfig and executes it in given mode Part of piping DSL

Methods inherited from class eu.jrie.jetbrains.kotlinshell.shell.piping.ShellPiping
cd, cd, cd, cd, env, file, file, mkdir
Methods inherited from class eu.jrie.jetbrains.kotlinshell.shell.Shell
byVPID, daemon, detach, forkErr, forkErr, forkErr, forkErr, invoke, invoke, invoke, invoke, join, join, joinAll, kill, kill, killAll, kts, ktsBuilder, ktsProcess, pipelineFork, process, process, running, systemBuilder, systemProcess, systemProcess, systemProcess, terminated
Methods inherited from class eu.jrie.jetbrains.kotlinshell.shell.piping.ShellForking
byteArrayLambda, contextLambda, emptyByteArray, emptyPacket, packet, packet, packetLambda, streamLambda, stringLambda
Methods inherited from class eu.jrie.jetbrains.kotlinshell.shell.ShellUtility
closeOut, command, invoke
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNullin
```
 final ReceiveChannel<ByteReadPacket> getNullin()
```
Dummy input channel. Behaves like /dev/null.

getNullout
```
 final SendChannel<ByteReadPacket> getNullout()
```
Dummy output channel. Behaves like /dev/null.

getStdin

 final ReceiveChannel<ByteReadPacket> getStdin()

getEnvironment
```
 final Map<String, String> getEnvironment()
```
Environment of this shell. These variables are being inherited to sub shells.

setEnvironment

 final Unit setEnvironment(Map<String, String> environment)

getVariables
```
 final Map<String, String> getVariables()
```
Variables of this shell. These variables are not being inherited to sub shells.

setVariables

 final Unit setVariables(Map<String, String> variables)

getDirectory
```
 final File getDirectory()
```
Current directory of this shell

setDirectory

 final Unit setDirectory(File directory)

getDetachedProcesses

 List<Pair<Integer, Process>> getDetachedProcesses()

getDaemons
```
 List<Process> getDaemons()
```

getDetachedPipelines

 List<Pair<Integer, Pipeline>> getDetachedPipelines()

getJobs

 final SuspendFunction1<ExecutionContext, Unit> getJobs()

getScope
```
 final CoroutineScope getScope()
```
CoroutineScope used by this shell, its members and sub shells

getCommander
```
 final ProcessCommander getCommander()
```

getStdout

 final SendChannel<ByteReadPacket> getStdout()

getStderr

 final SendChannel<ByteReadPacket> getStderr()

getEnv

 SuspendFunction1<ExecutionContext, Unit> getEnv()

getSet

 SuspendFunction1<ExecutionContext, Unit> getSet()

getShellEnv
```
 Map<String, String> getShellEnv()
```

getSystemEnv
```
 Map<String, String> getSystemEnv()
```

getProcesses
```
 List<Process> getProcesses()
```

getPs

 SuspendFunction1<ExecutionContext, Unit> getPs()

cd
```
 File cd(File dir)
```
Changes directory to given dir

variable

 Unit variable(Pair<String, String> variable)

Adds new shell variable

variable

 Unit variable(Readonly $self, Pair<String, String> variable)

export
```
 Unit export(Pair<String, String> env)
```
Adds new environment variable

export

 Unit export(Readonly $self, Pair<String, String> env)

unset
```
 Unit unset(String key)
```
Removes shell or environmental variable matching given key

detach
```
 Process detach(ProcessExecutable executable)
```
Detaches process from the shell and executes it in the background

detach
```
 Pipeline detach(SuspendFunction1<AbstractPipingDSLShell, Pipeline> pipelineConfig)
```
Creates new Pipeline specified by DSL pipelineConfig and executes it as detached job. Part of piping DSL

joinDetached
```
 Unit joinDetached()
```
Joins all detached processes

fg
```
 final Unit fg(Integer index)
```
Attaches job with given index

fg
```
 Unit fg(Process process)
```
Attaches selected Process

fg
```
 Unit fg(Pipeline pipeline)
```
Attaches selected Pipeline

daemon

 Process daemon(ProcessExecutable executable)

finalize
```
 Unit finalize()
```

shell

 final Unit shell(Map<String, String> vars, File dir, SuspendFunction1<Shell, Unit> script)

pipeline
```
 Pipeline pipeline(ExecutionMode mode, SuspendFunction1<AbstractPipingDSLShell, Pipeline> pipelineConfig)
```
Creates and executes new Pipeline specified by DSL pipelineConfig and executes it in given mode Part of piping DSL

Class Shell

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class eu.jrie.jetbrains.kotlinshell.shell.piping.ShellPiping

Methods inherited from class eu.jrie.jetbrains.kotlinshell.shell.Shell

Methods inherited from class eu.jrie.jetbrains.kotlinshell.shell.piping.ShellForking

Methods inherited from class eu.jrie.jetbrains.kotlinshell.shell.ShellUtility

Methods inherited from class java.lang.Object

Method Detail

getNullin

getNullout

getStdin

getEnvironment

setEnvironment

getVariables

setVariables

getDirectory

setDirectory

getDetachedProcesses

getDaemons

getDetachedPipelines

getJobs

getScope

getCommander

getStdout

getStderr

getEnv

getSet

getShellEnv

getSystemEnv

getProcesses

getPs

cd

variable

variable

export

export

unset

detach

detach

joinDetached

fg

fg

fg

daemon

finalize

shell

pipeline