Skip to content

Latest commit

 

History

121 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ES

The Command Line Interface for Everything.

Download
Install Guide
Usage
Search Options
Sort Options
Display Options
Journal Options
Export Options
General Options
Search Syntax
Notes
Error Levels
See Also



Download

https://github.com/voidtools/ES/releases

https://www.voidtools.com/downloads#cli


image


Install Guide

To install ES:

  • Download ES and extract es.exe to:
    %LOCALAPPDATA%\Microsoft\WindowsApps

This location is set in the PATH environment variable and allows es to be called from any directory in a command prompt or powershell.


Usage

es.exe [options] search text

For example:

es everything ext:exe;ini


Search Options

-r, -regex
Search using regular expressions.
-i, -case
Match case.
-w, -ww, -whole-word, -whole-words
Match whole words.
-p, -match-path
Match full path and file name.
-a, -diacritics
Match diacritical marks.

-o <offset>, -offset <offset>
Show results starting from offset.
-n <num>, -max-results <num>
Limit the number of results shown to <num>.

-path <path>
Search for subfolders and files in path.
-parent-path <path>
Search for subfolders and files in the parent of path.
-parent <path>
Search for files with the specified parent path.

/ad
Folders only.
/a-d
Files only.
/a[RHSDAVNTPLCOIE]
DIR style attributes search.
R = Read only.
H = Hidden.
S = System.
D = Directory.
A = Archive.
V = Device.
N = Normal.
T = Temporary.
P = Sparse file.
L = Reparse point.
C = Compressed.
O = Offline.
I = Not content indexed.
E = Encrypted.
- = Prefix a flag with - to exclude.



Sort Options

-s
sort by full path.
-sort <name[-ascending|-descending]>, -sort-<name>[-ascending|-descending]
Set sort
name=name|path|size|extension|date-created|date-modified|date-accessed|
attributes|file-list-file-name|run-count|date-recently-changed|date-run
-sort-ascending, -sort-descending
Set sort order

/on, /o-n, /os, /o-s, /oe, /o-e, /od, /o-d
DIR style sorts.
N = Name.
S = Size.
E = Extension.
D = Date modified.
- = Sort in descending order.



Display Options

-name
-path-column
-full-path-and-name, -filename-column
-extension, -ext
-size
-date-created, -dc
-date-modified, -dm
-date-accessed, -da
-attributes, -attribs, -attrib
-file-list-file-name
-run-count
-date-run
-date-recently-changed, -rc
Show the specified column.

-highlight
Highlight results.
-highlight-color <color>
Highlight color 0x00-0xFF:
image

-csv
-efu
-json
-m3u
-m3u8
-tsv
-txt
Change display format.

-size-format <format>
0=auto, 1=Bytes, 2=KB, 3=MB.
-date-format <format>
0=auto, 1=ISO-8601, 2=FILETIME, 3=ISO-8601(UTC)

-filename-color <color>
-name-color <color>
-path-color <color>
-extension-color <color>
-size-color <color>
-date-created-color <color>, -dc-color <color>
-date-modified-color <color>, -dm-color <color>
-date-accessed-color <color>, -da-color <color>
-attributes-color <color>
-file-list-filename-color <color>
-run-count-color <color>
-date-run-color <color>
-date-recently-changed-color <color>, -rc-color <color>
Set the column color 0x00-0xFF:
image

-filename-width <width>
-name-width <width>
-path-width <width>
-extension-width <width>
-size-width <width>
-date-created-width <width>, -dc-width <width>
-date-modified-width <width>, -dm-width <width>
-date-accessed-width <width>, -da-width <width>
-attributes-width <width>
-file-list-filename-width <width>
-run-count-width <width>
-date-run-width <width>
-date-recently-changed-width <width>, -rc-width <width>
Set the column width 0-200.

-no-digit-grouping
Don't group numbers with commas.
-size-leading-zero
-run-count-leading-zero
Format the number with leading zeros, use with -no-digit-grouping.
-double-quote
Wrap paths and filenames with double quotes.



Journal options

Requires Everything 1.5

-journal [filename-filter]
-j [filename-filter]
Show index journal changes.
Any journal option below also shows journal changes.
Wildcards are supported in the filename-filter.
Match the whole case-insensitive filename.
Both the filename before and after the change are searched.
Use a path separator (\) to match the full path.
-get-journal-id
Return the current journal ID.
-get-journal-pos
Return the current journal ID and next change ID.
-action-filter <actions>
Show only changes with the specified actions.
Use a semicolon (;) to separate multiple actions.
Actions can be one or more of the following:
folder-create
folder-delete
folder-rename
folder-move
folder-modify
file-create
file-delete
file-rename
file-move
file-modify
-added-filename-only
Match filenames created, renamed, or moved after the change.
-removed-filename-only
Match filenames deleted, renamed, or moved before the change.
-watch
Return when a matching journal change is found and display the journal position.
-from-journal-pos <journal-id> <change-id>
-from-journal-id <journal-id>
-from-change-id <change-id>
Show changes starting from the specified position.
-from-date <date>
Show changes starting from the specified ISO-8601 date.
-from-yesterday
Show changes starting from the beginning of yesterday.
-from-today
Show changes starting from the beginning of today.
-from-now
Show changes starting from the current time.
-to-journal-pos <journal-id> <change-id>
-to-journal-id <journal-id>
-to-change-id <change-id>
Show changes up to the specified journal position (exclusive).
-to-date <date>
Show changes up to the specified ISO-8601 date (exclusive).
-to-today
Show changes up to the start of today (exclusive).
-to-tomorrow
Show changes up to the start of tomorrow (exclusive).
-to-now
Show changes up to the current time (exclusive).
-after-journal-pos <journal-id> <change-id>
Show changes after the specified journal ID and change ID.
-changed-today
Show changes from the start of today until the start of tomorrow.
Same as -from-today -to-tomorrow
-changed-yesterday
Show changes from the start of yesterday until the start of today.
Same as -from-yesterday -to-today



Export Options

-export-csv <out.csv>
-export-efu <out.efu>
-export-json <out.json>
-export-m3u <out.m3u>
-export-m3u8 <out.m3u8>
-export-tsv <out.txt>
-export-txt <out.txt>
Export to a file using the specified layout.
-no-header
Do not output a column header for CSV, EFU and TSV files.
-utf8-bom
Store a UTF-8 byte order mark at the start of the exported file.



General Options

-h, -help
Display this help.

-instance <name>
Connect to the unique Everything instance name.
-ipc1, -ipc2
Use IPC version 1 or 2.
-argv
Use CommandLineToArgvW to parse the command line.
Use with Powershell 7 or later.
-pause, -more
Pause after each page of output.
-hide-empty-search-results
Don't show any results when there is no search.
-empty-search-help
Show help when no search is specified.
-timeout <milliseconds>
Timeout after the specified number of milliseconds to wait for
the Everything database to load before sending a query.

-set-run-count <filename> <count>
Set the run count for the specified filename.
-inc-run-count <filename>
Increment the run count for the specified filename by one.
-get-run-count <filename>
Display the run count for the specified filename.
-get-result-count
Display the result count for the specified search.
-get-total-size
Display the total result size for the specified search.
-save-settings, -clear-settings
Save or clear settings.
-version
Display ES major.minor.revision.build version and exit.
-get-everything-version
Display Everything major.minor.revision.build version and exit.
-exit
Exit Everything.
Returns after Everything process closes.
-save-db
Save the Everything database to disk.
Returns after saving completes.
-reindex
Force Everything to reindex.
Returns after indexing completes.
-no-result-error
Set the error level if no results are found.



Search Syntax

spaceAND
|OR
!NOT
< >Grouping
" "Escape operator characters.



Notes

Internal -'s in options can be omitted, eg: -nodigitgrouping

Switches can also start with a /

Use double quotes to escape spaces and switches.

Switches can be disabled by prefixing them with no-, eg: -no-size

Use a ^ prefix or wrap with double quotes (") to escape \ & | > < ^ in a command prompt.


Error Levels

Return codes from ES:

0No known error, search successful.
1Failed to register window class
2Failed to create listening window.
3Out of memory
4Expected an additional command line option with the specified switch
5Failed to create export output file
6Unknown switch.
7Failed to send Everything IPC a query.
8No Everything IPC window - make sure the Everything search client is running.
9No results found when used with -no-result-error



See Also

About

Everything Command Line Interface

Resources

Stars

277 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages