Menu  Toggle search  [ ![](https://winscp-
static-746341.c.cdn77.org/assets/images/logos/logo.png?v=7032) WinSCP  Free
SFTP, SCP, S3 and FTP client  for  Windows  ](https://winscp.net/)

  * [ Home ](/eng/index.php)
  * [ News ](/eng/news.php)
  * [ Introduction ](/eng/docs/introduction)
  * [ Download ](/eng/download.php)
  * [ Install ](/eng/docs/guide_install)
  * [ Documentation ](/eng/docs/)
  * [ Forum ](/forum/)

Close

Search

Close

[ Documentation ](/eng/docs/start "Documentation") » [ Features
](/eng/docs/feature_index "Features") » [ Scripting ](/eng/docs/scripting
"Scripting") » [ Script Commands ](/eng/docs/scripting#commands "Script
Commands") »

#  ls command

Lists the contents of specified remote directory.

  * Syntax 
  * Remarks 
  * Examples 
  * Converting to .NET Assembly 

_Advertisement_

##  Syntax

    
    
    ls [ <directory> ]/[ <wildcard> ]
    

##  Remarks

Lists the contents of specified remote directory. If ` directory ` is not
specified, lists working directory. When ` [ wildcard ](/eng/docs/file_mask) `
1  is specified, it is treated as set of files to list. Otherwise, all files
are listed.

Alias: ` dir `

Effective [ options ](/eng/docs/scriptcommand_option) : ` [ failonnomatch
](/eng/docs/scriptcommand_option#failonnomatch) `

XML  log element: ` [ ls ](/eng/docs/logging_xml#ls) `

##  Examples

    
    
    [ls](https://winscp.net/eng/docs/scriptcommand_ls) *.html
    
    
    [ls](https://winscp.net/eng/docs/scriptcommand_ls) /home/martin
    
    
    [ls](https://winscp.net/eng/docs/scriptcommand_ls)

_Advertisement_

    
    
    [ls](https://winscp.net/eng/docs/scriptcommand_ls) /home/martin/*.html

##  Converting to .NET Assembly

When [ converting script to .NET Assembly ](/eng/docs/library_from_script) ,
map ` ls ` command to ` [ Session.ListDirectory
](/eng/docs/library_session_listdirectory) ` method and print returned ` [
RemoteDirectoryInfo ](/eng/docs/library_remotedirectoryinfo) ` in your
preferred format.

Parameters mapping: Command parameter ` directory/wildcard ` maps to method
parameter ` path ` . You have to [ convert relative path to absolute path
](/eng/docs/library_from_script#paths) .

For example, following script snippet:

    
    
    [cd](https://winscp.net/eng/docs/scriptcommand_cd) /home/martinp
    [ls](https://winscp.net/eng/docs/scriptcommand_ls)

maps to following [ PowerShell ](/eng/docs/library_powershell) code:

    
    
    $directory = $session.ListDirectory("/home/martinp")
     
    foreach ($fileInfo in $directory.Files)
    {
        Write-Host ("{0}{1} {2,9} {3,-12:MMM dd HH:mm:ss yyyy} {4}" -f
            $fileInfo.FileType, $fileInfo.[FilePermissions](https://winscp.net/eng/docs/library_filepermissions), $fileInfo.Length,
            $fileInfo.LastWriteTime, $fileInfo.Name)
    }

Note that this omits inode, owner and group as these are not available in .NET
assembly.

  1. Only single include mask can be specified.  Back 

##  Contribute

![PayPal](https://winscp-
static-746341.c.cdn77.org/assets/images/paypal.svg?v=7032)

[ Donate ](/eng/donate.php)

  * [ $9 ](/eng/donate.php?amount=9&currency=USD&class=S "Donate $9 via PayPal")
  * [ $19 ](/eng/donate.php?amount=19&currency=USD&class=S "Donate $19 via PayPal")
  * [ $49 ](/eng/donate.php?amount=49&currency=USD&class=S "Donate $49 via PayPal")
  * [ $99 ](/eng/donate.php?amount=99&currency=USD&class=S "Donate $99 via PayPal")

![Visa](https://winscp-static-746341.c.cdn77.org/assets/images/card-logo-
visa.svg?v=7032) ![Mastercard](https://winscp-
static-746341.c.cdn77.org/assets/images/card-logo-mastercard.svg?v=7032)
![American Express](https://winscp-
static-746341.c.cdn77.org/assets/images/card-logo-amex.svg?v=7032)
![Other](https://winscp-static-746341.c.cdn77.org/assets/images/card-logo-
unknown.svg?v=7032)

##  User Approved Software

###  Total Downloads:

214,431,241

###  Rating:

4.8  out of  195  reviews

[ SourceForge Review ](https://sourceforge.net/projects/winscp/revi