ugrep

https://ugrep.com/
Admin
ugrep is an ultra-fast, user-friendly, and powerful grep replacement that searches files, archives,...
Tokens:3,212
Snippets:31
Trust Score:7.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Getting Help with ugrep Commands

Source: https://ugrep.com/index

Provides help documentation for regex patterns or specific command options. Users can query for detailed information on syntax and usage.

```bash
ug --help regex
```

--------------------------------

### Replacing Matches with Text Substitutions in ugrep

Source: https://ugrep.com/index

This example shows how to use the -P option with multiple patterns and the --replace option to substitute matched text with corresponding alternative text. The 'g' flag at the end of the --replace format string indicates a global replacement.

```ugrep command-line
ug -P -iw "(one)|(two)|(three)" --replace="%[ūnum|duo|tria]g"
```

--------------------------------

### Filtering Search Results with External Commands

Source: https://ugrep.com/index

Allows piping search results to external commands for further processing or filtering. This example uses `openssl` to search certificate data.

```bash
ug _PATTERN_ -Opem --filter="pem:openssl x509 -passin pass: -text -in %
```

--------------------------------

### Configuring ugrep Aliases

Source: https://ugrep.com/index

Sets up shell aliases to replace standard grep commands with `ugrep` equivalents, enabling `ugrep`'s advanced features for common search tasks.

```bash
alias grep='ug -G'; alias egrep='ug -E'; alias fgrep='ug -F'; alias zgrep='ug -zG'; alias zegrep='ug -zE'; alias zfgrep='ug -zF'
```

--------------------------------

### Basic Indexing and Verbose Output with ugrep-indexer

Source: https://ugrep.com/index

This command recursively indexes the current directory, ignoring binary files and including archives. The -v flag provides verbose output, showing the indexing progress.

```bash
ugrep-indexer -Iz -v
```

--------------------------------

### Interactive Search with ugrep

Source: https://ugrep.com/index

Initiates an interactive query TUI for searching patterns. Users can recursively search for matching files and access help or options within the TUI.

```bash
ug -Q
```

```bash
ug -%% -jwQ
```

--------------------------------

### XML Output Formatting in ugrep

Source: https://ugrep.com/index

This snippet illustrates the internal format strings ugrep uses for XML output. It defines the root element, file entries with names, and individual match elements containing line, column, offset, and the matched text.

```ugrep configuration
--format-begin='<grep>%~'
--format-open='  <file%[\"]$%[ name=\"]I>%~'
--format='    <match%[\"]$%[ line=\"]N%[ column=\"]K%[ offset=\"]B>%X</match>%~%u'
--format-close='  </file>%~'
--format-end='</grep>%~'
```

--------------------------------

### Searching Archives and Compressed Files with ugrep

Source: https://ugrep.com/index

Enables searching within archives and compressed files. Options allow for listing file contents, applying fuzzy matching, and safely paging through content.

```bash
ug -z _PATTERN_
```

```bash
ug -z -tc,cpp -Z PATTERN
```

```bash
ug -z -l "" package.zip
```

```bash
ug -z -W --pager "" mailattachment.zip
```

--------------------------------

### Indexing a Specific Directory with Verbose Output using ugrep-indexer

Source: https://ugrep.com/index

This command performs a recursive index of a specified directory path (_PATH_), ignoring binary files and including archives, with verbose output to monitor the process.

```bash
ugrep-indexer -Iz -v _PATH_
```

--------------------------------

### Filter documents and e-books with pandoc

Source: https://ugrep.com/index

This filter handles a variety of document and e-book formats (odt, docx, epub, rtf) by converting them to plain text using `pandoc`. The output is formatted with preserved wrapping. The `%` argument is expanded to the file path.

```shell
--filter="odt,docx,epub,rtf:pandoc --wrap=preserve -t plain % -o -"
```

--------------------------------

### Index-Based Recursive Search on a Specific Path with ugrep

Source: https://ugrep.com/index

This command executes a recursive search using indexes on a specified directory (_PATH_). It ignores binary files (-I) and includes archives (-z), with _OPTIONS_ and _PATTERN_ representing search criteria.

```bash
ug --index -r -Iz _OPTIONS_ _PATTERN_ _PATH_
```

--------------------------------

### JSON Output Formatting in ugrep

Source: https://ugrep.com/index

This snippet shows the internal format strings used by ugrep to produce JSON output. It defines structures for the overall JSON array, individual file entries, and match details within each file.

```ugrep configuration
--format-begin='['
--format-open='%,%~  {%~    %[,%~    ]$%["file": ]H"matches": ['
--format='%,%~      { %[, ]$%["line": ]N%["column": ]K%["offset": ]B"match": %J }%u'
--format-close='%~    ]%~  }'
--format-end='%~]%~'
```

--------------------------------

### Filter office documents with soffice

Source: https://ugrep.com/index

This filter searches documents, spreadsheets, and presentations (odt, doc, docx, rtf, xls, xlsx, ppt, pptx) by converting them to plain text using LibreOffice in headless mode. This method can be slow. The `%` argument is expanded to the file path.

```shell
--filter="odt,doc,docx,rtf,xls,xlsx,ppt,pptx:soffice --headless --cat %"
```

--------------------------------

### Save ugrep Configuration

Source: https://ugrep.com/index

Saves the current `ug` configuration to a `.ugrep` file in the working directory. This command allows for persistent configuration settings.

```bash
ug --save-config _OPTIONS_
```

```bash
ug --save-config --ignore-files --ignore-binary --decompress
```

--------------------------------

### Basic File and Directory Search with ugrep

Source: https://ugrep.com/index

Performs recursive or targeted searches for patterns within files or directories. If no search targets are specified, the working directory is searched recursively.

```bash
ug _PATTERN_
```

```bash
ug _PATTERN_ _FILE_
```

```bash
ug _PATTERN_ _DIR_
```

```bash
ug -r _PATTERN_ _DIR_
```

```bash
ug -rS _PATTERN_ _DIR_
```

```bash
ug -R _PATTERN_ _DIR_
```

```bash
ug -3 _PATTERN_ _DIR_
```

```bash
ug -3 -g"foo*.txt" _PATTERN_ _DIR_
```

--------------------------------

### Performing Index-Based Recursive Search with ugrep

Source: https://ugrep.com/index

This command performs a recursive search using precomputed indexes. It ignores binary files (-I) and searches within archives (-z). _OPTIONS_ and _PATTERN_ should be replaced with relevant search parameters.

```bash
ug --index -Iz _OPTIONS_ _PATTERN_
```

--------------------------------

### Force Full Re-indexing with Minimal Index Size using ugrep-indexer

Source: https://ugrep.com/index

This command forces a complete re-indexing of the specified directory (_PATH_), prioritizing minimal index file size by using the lowest index match accuracy (-0). Verbose output is enabled.

```bash
ugrep-indexer -f -0 -Iz -v _PATH_
```

--------------------------------

### Filter image metadata with exiftool

Source: https://ugrep.com/index

This filter extracts metadata from various image and media file formats (gif, jpg, jpeg, mpg, mpeg, png, tiff) using the `exiftool` command. The `%` argument is expanded to the file path.

```shell
--filter="gif,jpg,jpeg,mpg,mpeg,png,tiff:exiftool %"
```

--------------------------------

### Filter object files with nm

Source: https://ugrep.com/index

This filter searches object files and libraries (o, a, so) for undefined symbols using the `nm -gU` command. The `%` argument is expanded to the file path.

```shell
--filter="o,a,so:nm -gU %"
```

--------------------------------

### CSV Output Formatting in ugrep

Source: https://ugrep.com/index

This snippet demonstrates how ugrep internally formats output for the --csv option. It utilizes specific format-open and format strings to define the CSV structure, separating fields with commas and using '%+' for field expansion.

```ugrep configuration
--format-open='%+'
--format='%[,]$%H%N%K%B%V%~%u'
```

--------------------------------

### Filter PDF files with pdftotext

Source: https://ugrep.com/index

This filter searches PDF files by converting them to plain text using `pdftotext`. The `%` argument is expanded to the file path. The command reads from standard input if `-` is provided as an argument to `pdftotext`.

```shell
--filter="pdf:pdftotext % -"
```

--------------------------------

### Filter certificates with openssl

Source: https://ugrep.com/index

This filter searches various certificate file formats (.pem, .cer, .crt, .der) using `openssl x509`. It supports both text and DER encoded certificates. The `%` argument is expanded to the file path. A placeholder `pass:` is included for password-protected keys.

```shell
--filter="pem:openssl x509 -passin pass: -text -in %,cer,crt,der:openssl x509 -passin pass: -text -inform der -in %"
```

--------------------------------

### Define File Types with Extensions

Source: https://ugrep.com/index

Associates a file type with a comma-separated list of filename extensions. This is achieved using the `-O` option within ugrep's file type definitions. It helps in identifying files based on their extensions.

```ugrep
actionscript = -O as,mxml
ada = -O ada,adb,ads
asm = -O asm,s,S
basic = -O bas,BAS,cls,frm,ctl,vb,resx
batch = -O bat,BAT,cmd,CMD
c = -O c,h,H,hdl,xs
c++ = -O cpp,CPP,cc,cxx,CXX,h,hh,H,hpp,hxx,Hxx,HXX
clojure = -O clj
cpp = -O cpp,CPP,cc,cxx,CXX,h,hh,H,hpp,hxx,Hxx,HXX
csharp = -O cs
css = -O css
csv = -O csv
dart = -O dart
delphi = -O pas,int,dfm,nfm,dof,dpk,dproj,groupproj,bdsgroup,bdsproj
elisp = -O el
elixir = -O ex,exs
erlang = -O erl,hrl
fortran = -O for,ftn,fpp,f,F,f77,F77,f90,F90,f95,F95,f03,F03
gif = -O gif
go = -O go
groovy = -O groovy,gtmpl,gpp,grunit,gradle
gsp = -O gsp
haskell = -O hs,lhs
html = -O htm,html,xhtml
jade = -O jade
java = -O java,properties
jpeg = -O jpg,jpeg
js = -O js
json = -O json
jsp = -O jsp,jspx,jthm,jhtml
julia = -O jl
kotlin = -O kt,kts
less = -O less
lex = -O l,ll,lmm,lpp,lxx
lisp = -O lisp,lsp
lua = -O lua
m4 = -O m4
make = -O mk,mak
markdown = -O md
matlab = -O m
node = -O js
objc = -O m,h
objc++ = -O mm,h

```

--------------------------------

### Filter documents with antiword

Source: https://ugrep.com/index

This filter processes document files using the `antiword` utility, which is commonly used for older Word document formats. The `%` argument is expanded to the file path.

```shell
--filter="doc:antiword %"
```

--------------------------------

### Checking Directory Indexes with ugrep-indexer

Source: https://ugrep.com/index

This command checks the integrity and status of the indexes for the specified directory path (_PATH_). If no path is provided, it checks the current working directory.

```bash
ugrep-indexer -c _PATH_
```

--------------------------------

### Define File Types with Makefile Patterns

Source: https://ugrep.com/index

Associates a file type with specific filename patterns commonly found in build system files, such as Makefiles. This uses the `-g` option to match general file patterns, useful for build-related files.

```ugrep
make = -g makefile,Makefile,Makefile.Debug,Makefile.Release
ruby = -g Rakefile

```

--------------------------------

### Filter Shift-JIS encoded files with iconv

Source: https://ugrep.com/index

This filter converts Shift-JIS encoded files to UTF-8 for searching using the `iconv` utility. This is a specific encoding conversion. The command reads from standard input.

```shell
--filter="jis:iconv -f SHIFT-JIS -t UTF-8"
```

--------------------------------

### Define File Types with Magic Bytes

Source: https://ugrep.com/index

Associates a file type with a specific magic byte signature using the `-M` option. This allows ugrep to identify files based on their content, even if the filename extension is missing or incorrect. This is useful for binary files.

```ugrep
Awk = -M '#!\h*/.*\Wg?awk(\W.*)?\n'
Dart = -M '#!\h*/.*\Wdart(\W.*)?\n'
Gif = -M 'GIF87a|GIF89a'
Jpeg = -M '\xff\xd8\xff[\xdb\xe0\xe1\xee]'
Node = -M '#!\h*/.*\Wnode(\W.*)?\n'
Pdf = -M '\x25\x50\x44\x46\x2d'
Perl = -M '#!\h*/.*\Wperl(\W.*)?\n'
Php = -M '#!\h*/.*\Wphp(\W.*)?\n'
Png = -M '\x89PNG\x0d\x0a\x1a\x0a'
Python = -M '#!\h*/.*\Wpython[23]?(\W.*)?\n'
Rpm = -M '\xed\xab\xee\xdb'
Rtf = -M '\{\rtf1'
Ruby = -M '#!\h*/.*\Wruby(\W.*)?\n'
Shell = -M '#!\h*/.*\W(ba|da|t?c|k|z|fi)?sh(\W.*)?\n'
Tiff = -M '\x49\x49\x2a\x00|\x4d\x4d\x00\x2a'
Xml = -M '<\?xml '

```

--------------------------------

### Recursive Search in a File Without Using an Index with ugrep

Source: https://ugrep.com/index

This command performs a recursive search within a specified file (_FILE_). Notably, it does not utilize any precomputed indexes for this search, focusing solely on recursive searching acceleration.

```bash
ug --index _OPTIONS_ _PATTERN_ _FILE_
```

--------------------------------

### Filter all files with file utility

Source: https://ugrep.com/index

This filter uses the `file` utility to determine the file type of every file. This option is intended for general file type identification. Note: This feature is not available on Windows until ugrep version 7.1.

```shell
--filter="*:file %"
```

--------------------------------

### Deleting Index Files from a Directory with ugrep-indexer

Source: https://ugrep.com/index

This command removes the hidden index files from the specified directory path (_PATH_). If no path is given, it deletes indexes from the current working directory.

```bash
ugrep-indexer -d _PATH_
```
Tokens:
Raw