The Silver Searcher

A code searching tool similar to ack, with a focus on speed.

What's so great about Ag?

It searches code about 3–5× faster than ack.
It ignores file patterns from your .gitignore and .hgignore.
If there are files in your source repo you don't want to search, just add their patterns to a .agignore file. *cough* extern *cough*
The command name is 33% shorter than ack, and all keys are on the home row!

How is it so fast?

Searching for literals (no regex) uses Boyer-Moore-Horspool strstr.
Files are mmap()ed instead of read into a buffer.
If you're building with PCRE 8.21 or greater, regex searches use the JIT compiler.
Ag calls pcre_study() before executing the regex on a jillion files.
Instead of calling fnmatch() on every pattern in your ignore files, non-regex patterns are loaded into an array and binary searched.
Ag uses Pthreads to take advantage of multiple CPU cores and search files in parallel.

I've written several blog posts showing how I've improved performance. These include how I added pthreads, wrote my own scandir(), benchmarked every revision to find performance regressions, and profiled with gprof and Valgrind.

Installation

Gentoo

emerge the_silver_searcher

OS X

brew install the_silver_searcher

port install the_silver_searcher

Arch Linux

pacman -S the_silver_searcher

Debian unstable

apt-get install silversearcher-ag

Ubuntu 13.10 or later

apt-get install silversearcher-ag

FreeBSD

pkg install the_silver_searcher

pkg_add -r the_silver_searcher

To build from source on FreeBSD:

make -C /usr/ports/textproc/the_silver_searcher install clean

OpenBSD

pkg_add the_silver_searcher

To build from source on OpenBSD:

cd /usr/ports/textproc/the_silver_searcher && make install

If you want a CentOS rpm or Ubuntu deb, take a look at Vikram Dighe's packages.

Building from source

Install dependencies (Automake, pkg-config, PCRE, LZMA):

Ubuntu:

  apt-get install -y automake pkg-config libpcre3-dev zlib1g-dev liblzma-dev

Fedora:

  yum -y install pkgconfig automake gcc zlib-devel pcre-devel xz-devel

CentOS:

  yum -y groupinstall "Development Tools"
  yum -y install pcre-devel xz-devel

OS X:

  brew install automake pkg-config pcre

  port install automake pkgconfig pcre

Windows: It's complicated. See this wiki page.

Run the build script (which just runs aclocal, automake, etc):
```
 ./build.sh
```

On Windows:

    mingw32-make -f Makefile.w32

Make install:
```
 sudo make install
```

Current development status

It's quite stable now. Most changes are new features, minor bug fixes, or performance improvements. It's much faster than Ack in my benchmarks.

ack blahblahblah ~/code  6.59s user 1.94s system 99% cpu 8.547 total

ag blahblahblah ~/code  1.39s user 1.81s system 229% cpu 1.396 total

Editor Integration

TextMate

TextMate users can use Ag with my fork of the popular AckMate plugin, which lets you use both Ack and Ag for searching. If you already have AckMate you just want to replace Ack with Ag, move or delete "~/Library/Application Support/TextMate/PlugIns/AckMate.tmplugin/Contents/Resources/ackmate_ack" and run ln -s /usr/local/bin/ag "~/Library/Application Support/TextMate/PlugIns/AckMate.tmplugin/Contents/Resources/ackmate_ack"

Vim

You can use Ag with [ack.vim][] by adding the following line to your .vimrc:

let g:ackprg = 'ag --nogroup --nocolor --column'

There's also a fork of ack.vim tailored for use with Ag: [ag.vim][] [ack.vim]: https://github.com/mileszs/ack.vim [ag.vim]: https://github.com/rking/ag.vim

Emacs

You can use use ag.el as an Emacs fronted to Ag.

Contributing

I like when people send pull requests. It validates my existence. If you want to help out, check the issue list or search the codebase for TODO. Don't worry if you lack experience writing C. If I think a pull request isn't ready to be merged, I'll give feedback in comments. Once everything looks good, I'll comment on your pull request with a cool animated gif and hit the merge button.

TODO

A special thanks goes out to Alex Davies. He has given me some excellent recommendations to improve Ag. Many of these things are still on my list:

Optimizations
- Write a benchmarking script that tweaks various settings to find what's fastest.
Features
- Behave better when matching in files with really long lines.
- Report "match found at position X of line N" if line is > 10k chars.
Windows support
- readdir() and stat() are much slower on Windows. Use FindNextFile() instead.
- Support Visual Studio instead of autotools?
- Need to use pthreads-win32 or something similar.

Other stuff you might like

Ack - Better than grep. Without Ack, Ag would not exist.
AckMate - An ack-powered replacement for TextMate's slow built-in search.
ack.vim
ag.vim
Exuberant Ctags - Faster than Ag, but it builds an index beforehand. Good for really big codebases.
Git-grep - As fast as Ag but only works on git repos.
Sack - A utility that wraps Ack and Ag. It removes a lot of repetition from searching and opening matching files.

yongzhy/the_silver_searcher