Class R2Shell

constructor

• new R2Shell(papi): R2Shell

• Create a new instance of the R2Shell

     *
  Copy

  Parameters

  • papi: R2Papi

  Returns R2Shell

  instance of the shell api

rp

chdir

• chdir(path): boolean

• Change current directory

     *
  Copy

  Parameters

  • path: string

    to the directory *

  Returns boolean

  true if successful

chdir2

• chdir2(path): void

• Change current directory on the internal radare2 filesystem

     *
  Copy

  Parameters

  • path: string

    name to change to *

  Returns void

  TODO: should return boolean

enumerateFilesystemTypes

• enumerateFilesystemTypes(): any[]

• Enumerate all the mountpoints set in the internal virtual filesystem of radare2

  Returns any[]

  array of mount

enumerateMountpoints

• enumerateMountpoints(): any[]

• Enumerate all the mountpoints set in the internal virtual filesystem of radare2

  Returns any[]

  array of mount

fileExists

• fileExists(path): boolean

• TODO: Checks if a file exists (not implemented)

     *
  Copy

  Parameters

  • path: string

  Returns boolean

  true if the file exists, false if it does not

isDirectory

• isDirectory(file): boolean

• TODO: not implemented

  Parameters

  • file: string

  Returns boolean

isSymlink

• isSymlink(file): boolean

• TODO: not implemented

  Parameters

  • file: string

  Returns boolean

ls

• ls(): string[]

• List files in the current directory

     *
  Copy

  Returns string[]

  array of file names

ls2

• ls2(path): string[]

• List the files contained in the given path within the virtual radare2 filesystem.

     *
  Copy

  Parameters

  • path: string

    name to change to *

  Returns string[]

  TODO: should return boolean

mkdir

• mkdir(file, recursive?): boolean

• Create a new directory in the host system, if the opational recursive argument is set to true it will create all the necessary subdirectories instead of just the specified one.

     *
  Copy

  Parameters

  • file: string

  • Optional recursive: boolean

  Returns boolean

  true if successful

mount

• mount(fstype, path, offset): boolean

• Mount the given offset on the specified path using the filesytem. This is not a system-level mountpoint, it's using the internal filesystem abstraction of radare2.

     *
  Copy

  Parameters

  • fstype: string

  • path: string

  • offset: string | number

  Returns boolean

  return code (0 is success)

open

• open(arg): void

• Opens an URL or application Execute xdg-open on linux, start on windows, open on Mac

     *
  Copy

  Parameters

  • arg: string

  Returns void

system

• system(cmd): number

• Run a system command and get the return code

     *
  Copy

  Parameters

  • cmd: string

  Returns number

  return code (0 is success)

umount

• umount(path): void

• Unmount the mountpoint associated with the given path.

     *
  Copy

  Parameters

  • path: string

    to the mounted filesystem *

  Returns void

  TODO: should return boolean

unlink

• unlink(file): boolean

• Deletes a file

     *
  Copy

  Parameters

  • file: string

  Returns boolean

  true if successful