SSHShell

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def alive(): Boolean

get dir name

def arch: String

get server architecture string

final def asInstanceOf[T0]: T0

def basename(name: String, suffix: String): String

get base name

def basename(name: String): String

get base name

def become(someoneelse: String, password: Option[String] = None): Boolean

Become someoneelse on the current shell session, first the command will try (if new user password is given) su - newuser then if unsuccessful it will try the sudo su - approach, in that case it is the current user pass that will be used, new user password will be ignored.

def becomeWithSU(someoneelse: String, password: Option[String] = None): Boolean

def becomeWithSUDO(someoneelse: String): Boolean

def cat(filenames: List[String]): String

Get contents of a list of files

def cat(filename: String): String

Get the content of a file

def catData(data: String, filespec: String): Boolean

write some data to the specified filespec

def cd(dirname: String): Unit

Change current working directory to the specified directory Of course this requires a persistent shell session to be really useful...

def cd: Unit

Change current working directory to home directory Of course this requires a persistent shell session to be really useful...

def clone(): AnyRef

def close(): Unit

def date(): Date

Get remote date, as a java class Date instance (minimal resolution = 1 second)

def dirname(name: String): String

get dir name

def disableHistory(): Unit

Disable shell history, the goal is to not add noises to your shell history, to keep your shell commands history clean.

def du(filename: String): Option[Long]

Remote tree file size in kilobytes

def echo(message: String): String

echo something and return back what has been printed

def env: Map[String, String]

remote environment variables

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def execute(cmd: SSHCommand): String

Execute the current command and return the result as a string

def executeAndTrim(cmd: SSHCommand): String

Execute the current command and return the result as a trimmed string

def executeAndTrimSplit(cmd: SSHCommand): Iterable[String]

Execute the current command and return the result as a trimmed splitted string

def executeWithExpects(cmd: SSHCommand, expects: List[Expect]): (String, Int)

def executeWithStatus(cmd: SSHCommand): (String, Int)

Execute the current command and return the result as a string and exit code tuple

def exists(filename: String): Boolean

Does specified filename exist ?

def fileRights(path: String): Option[String]

get file rights string (such as 'drwxr-xr-x')

def fileSize(filename: String): Option[Long]

Remote file size in bytes

def finalize(): Unit

def findAfterDate(root: String, after: Date): Iterable[String]

Find file modified after the given date (Warning, minimal resolution = 1 minute)

def fsFreeSpace(path: String): Option[Double]

File system remaining space in MB

def get(remoteFilename: String): Option[String]

get remote file content as an optional String

def getBytes(remoteFilename: String): Option[Array[Byte]]

get remote file content as an optional bytes array

final def getClass(): Class[_]

def hashCode(): Int

def hostname: String

Get remote host name

def id: String

Get used id information

def inputStream2remoteFile(localinput: InputStream, datasize: Long, remoteFilename: String, remoteDirectory: String): Unit

upload a local input stream to a remote destination

def isDirectory(filename: String): Boolean

Is file name a directory

def isExecutable(filename: String): Boolean

Is filename executable ?

def isFile(filename: String): Boolean

Is file name a regular file

final def isInstanceOf[T0]: Boolean

def kill(pids: Iterable[Int]): Unit

kill specified processes

def lastModified(filename: String): Option[Date]

Remote file last modified date (TZ is taken into account)

def localmd5sum(filename: String): Option[String]

locale file md5sum

val logger: Logger

def ls(dirname: String): Iterable[String]

List files in specified directory

def ls(): Iterable[String]

List files in specified directory

def md5sum(filename: String): Option[String]

Remote file md5sum

def mkcd(dirname: String): Boolean

Create a new directory and enter it

def mkdir(dirname: String): Boolean

Create a new directory

final def ne(arg0: AnyRef): Boolean

def notExists(filename: String): Boolean

Does specified filename not exist ?

final def notify(): Unit

final def notifyAll(): Unit

val options: SSHOptions

get current SSH options

def osid: OS

*nix os name (linux, aix, sunos, darwin, ...)

def osname: String

*nix os name (linux, aix, sunos, darwin, ...)

def pid: Int

Returns the current shell process identifier

def pidof(regex: Regex): List[Int]

get pid of all processes matching the given command line regular expression

val prompt: String

def ps(): List[Process]

list active processes of unix like systems

def put(data: String, remoteDestination: String): Unit

upload string content to a remote file, if file already exists, it is overwritten

def putBytes(data: Array[Byte], remoteDestination: String): Unit

upload bytes array content to a remote file, if file already exists, it is overwritten

def putFromStream(data: InputStream, howmany: Int, remoteDestination: String): Unit

upload bytes coming from the input stream to a remote file, if file already exists, it is overwritten

def pwd(): String

Get current working directory

def receive(remoteFilename: String, outputStream: OutputStream): Unit

Copy a remote file to a local one

def receive(filename: String): Unit

Copy a remote file to a local one using the same filename

def receive(remoteFilename: String, localFilename: String): Unit

Copy a remote file to a local one

def receive(remoteFilename: String, toLocalFile: File): Unit

Copy a remote file to a local one

def receiveNcompress(remoteFilename: String, localDirectory: File, localBasename: String): File

Copy and compress (if required) a remote file to a local one

def receiveNcompress(remoteFilename: String, localFilename: String): File

Copy and compress (if required) a remote file to a local one

def remoteFile2OutputStream(remoteFilenameMask: String, outputStreamBuilder: (String) ⇒ OutputStream): Int

lookup for remote files, for each found file send the content to an OutputStream created using the specified builder

def rm(files: Iterable[String]): Unit

delete files

def rm(file: String): Unit

delete a file

def rmdir(dirs: Iterable[String]): Boolean

delete directories (directories must be empty)

def rmdir(dir: String): Boolean

delete directory (directory must be empty)

def rreceive(remote: String, dest: File): Unit

Recursively get a remote directory to a local destination

def rsend(src: File, remote: String): Unit

Recursively send a local directory to a remote destination

def send(fromLocalFile: File, remoteDestination: String): Unit

Copy a local file to a remote one

def send(filename: String): Unit

Copy a local file to a remote one using the same name

def send(fromLocalFilename: String, remoteDestination: String): Unit

Copy a local file to a remote one

def sha1sum(filename: String): Option[String]

Remote file sha1sum

def sudoSuMinusOnlyWithPasswordTest(): Boolean

Does the command sudo su - works with the current user password ? while preserving the TTY stdin !

def sudoSuMinusOnlyWithoutPasswordTest(): Boolean

Does the command "sudo su -" without password works ?

def sudoSuMinusWithCommandTest(cmd: String = "whoami"): Boolean

Does the command sudo "su - -c theGivenCommand" works ? Transparently with or without password

final def synchronized[T0](arg0: ⇒ T0): T0

def test(that: String): Boolean

Generic test (man test, for arguments)

def toString(): String

def touch(files: String*): Unit

touch

def uname: String

*nix system name (Linux, AIX, SunOS, ...)

def uptime: String

get host up time, example formats : Linux : 21:34:17 up 33 min, 5 users, load average: 0.18, 0.27, 0.30 21:29:38 up 473 days, 22:21, 1 user, load average: 0.09, 0.04, 0.00 Darwin : 21:28 up 53 mins, 3 users, load averages: 1.40 1.49 1.52

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def which(command: String): Option[String]

get command location on filesystem, based on current PATH

def whoami: String

who am I ?

def execute[I <: Iterable[String]](commands: I)(implicit bf: CanBuildFrom[I, String, I]): I

Execute a collection of commands and returns the associated result collections

def executeAll(cmds: SSHBatch): Iterable[String]

Execute the current batch (list of commands) and return the result as a string collection

def executeAllAndTrim(cmds: SSHBatch): Iterable[String]

Execute the current batch (list of commands) and return the result as a string collection

def executeAllAndTrimSplit(cmds: SSHBatch): Iterable[Array[String]]

Execute the current batch (list of commands) and return the result as a string collection

def executeAndContinue(cmd: SSHCommand, cont: (String) ⇒ Unit): Unit

Execute the current command and pass the result to the given code