The tldr-pages project is a collection of community-maintained help pages for command-line tools, that aims to be a simpler, more approachable complement to traditional man pages.

Maybe you're new to the command-line world? Perhaps you're just a little rusty or can't always recall the arguments for commands like lsof, or tar?

It certainly doesn't help that, in the past, the first option explained in man tar was:

$ man tar
...
-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...

There seems to be room for simpler help pages, focused on practical examples. How about:

This repository is just that: an ever-growing collection of examples…

jq is a lightweight and flexible command-line JSON processor akin to sed,awk,grep, and friends for JSON data. It's written in portable C and has zero runtime dependencies, allowing you to easily slice, filter, map, and transform structured data.

• Official Documentation: jqlang.github.io/jq
• Try jq Online: jqplay.org

Download the latest releases from the GitHub release page.

Pull the jq image to start quickly with Docker.

• libtool
• make
• automake
• autoconf

git submodule update --init # if building from git to get oniguruma
autoreconf -i               # if building from git
./configure --with-oniguruma=builtin
make -j8
make check
sudo make install

Build a statically linked version:

make LDFLAGS=-all-static

If you're not using the latest git version but instead building a released tarball (available on the release page), skip the autoreconf step, and flex or bison won't…

direnv is an extension for your shell. It augments existing shells with a new feature that can load and unload environment variables depending on the current directory.

• Load 12factor apps environment variables
• Create per-project isolated development environments
• Load secrets for deployment

Before each prompt, direnv checks for the existence of a .envrc file (and optionally a .env file) in the current and parent directories. If the file exists (and is authorized), it is loaded into a bash sub-shell and all exported variables are then captured by direnv and then made available to the current shell.

It supports hooks for all the common shells like bash, zsh, tcsh and fish. This allows project-specific environment variables without cluttering the ~/.profile file.

Because direnv is compiled into a single static executable, it is fast enough to be unnoticeable on each prompt. It is…

tmux is a terminal multiplexer: it enables a number of terminals to be created accessed, and controlled from a single screen. tmux may be detached from a screen and continue running in the background, then later reattached.

This release runs on OpenBSD, FreeBSD, NetBSD, Linux, macOS and Solaris.

tmux depends on libevent 2.x, available from this page.

It also depends on ncurses, available from this page.

To build tmux, a C compiler (for example gcc or clang), make, pkg-config and a suitable yacc (yacc or bison) are needed.

Some platforms provide binary packages for tmux, although these are sometimes out of date. Examples are listed on this page.

To build and install tmux from a release tarball, use:

./configure && make
sudo make install

tmux can use the utempter library to update utmp(5), if it is…

how2 finds the simplest way to do something in a unix shell It's like man, but you can query it in natural language. It uses a mix of AI code-completion and StackOverflow search.

It effectively replaces Chrome => New Tab => Google => Click on StackOverflow => Scroll Down to first answer.

Go to how2terminal.com for more info.

brew tap how2terminal/how2
brew install how2

sudo npm install -g how2

If you install it without sudo, then you have to run it with npx how2 or alias the command manually.

Download latest .deb and then run:

wget how2terminal.com/how2.deb
sudo dpkg -i how2.deb

Go to the latest release and download the binaries.

By default, how2 uses an external AI server to find the best unix command line suggestion If you add the -s…

ripgrep is a line-oriented search tool that recursively searches the current directory for a regex pattern. By default, ripgrep will respect gitignore rules and automatically skip hidden files/directories and binary files. (To disable all automatic filtering by default, use rg -uuu.) ripgrep has first class support on Windows, macOS and Linux, with binary downloads available for every release. ripgrep is similar to other popular search tools like The Silver Searcher, ack and grep.

Dual-licensed under MIT or the UNLICENSE.

Please see the CHANGELOG for a release history.

• Installation
• User Guide
• Frequently Asked Questions
• Regex syntax
• Configuration files
• Shell completions
• Building
• Translations

This example searches the entire Linux kernel source tree (after running make defconfig && make -j8) for [A-Z]+_SUSPEND, where all matches must be words. Timings were collected on a system…

A cat(1) clone with syntax highlighting and Git integration

Key Features • How To Use • Installation • Customization • Project goals, alternatives
[English] [中文] [日本語] [한국어] [Русский]

A special thank you goes to our biggest sponsors:

Your app, enterprise-ready.
_{Start selling to enterprise customers with just a few lines of code.}
^{Add Single Sign-On (and more) in minutes instead of months.}

Warp is a modern, Rust-based terminal with AI built in
so you and your team can build great software, faster.
_{Feel more productive on the command line with parameterized commands,}
^{autosuggestions, and an IDE-like text editor.}

bat supports syntax highlighting for a large number of programming and markup languages:

bat communicates with git to show modifications with respect to the index (see left side bar):

You can use the -A/…

^{Special thanks to:}

Warp is a modern, Rust-based terminal with AI built in so you and your team can build great software, faster.

^{Visit warp.dev to learn more.}

---

fzf is a general-purpose command-line fuzzy finder.

It's an interactive Unix filter for command-line that can be used with any list; files, command history, processes, hostnames, bookmarks, git commits etc.

• Portable, no dependencies
• Blazingly fast
• The most comprehensive feature set
• Flexible layout
• Batteries included
  • Vim/Neovim plugin, key bindings, and fuzzy auto-completion

I would like to thank all the sponsors of this project who make it possible for me to continue to improve fzf.

If you'd like to sponsor this project, please visit https://github.com/sponsors/junegunn.

• Installation
  • Using Homebrew
  • Using git
  • Using Linux package managers
  • Windows
  • Setting up shell integration
  • As Vim plugin
• Upgrading fzf
• Building fzf
• Usage
  • Using the finder
  • Layout
  • Search syntax
  • Environment variables
  • Options
  • Demo
• …

[中文] [한국어]

fd is a program to find entries in your filesystem It is a simple, fast and user-friendly alternative to find While it does not aim to support all of find's powerful functionality, it provides sensible (opinionated) defaults for a majority of use cases.

Installation • How to use • Troubleshooting

A special thank you goes to our biggest sponsors:

The $HOME of all things in the terminal.

• Intuitive syntax: fd PATTERN instead of find -iname '*PATTERN*'.
• Regular expression (default) and glob-based patterns.
• Very fast due to parallelized directory traversal.
• Uses colors to highlight different file types (same as ls).
• Supports parallel command execution
• Smart case: the search is case-insensitive by default. It switches to case-sensitive if…

autojump - a faster way to navigate your filesystem

autojump is a faster way to navigate your filesystem. It works by maintaining a database of the directories you use the most from the command line.

Directories must be visited first before they can be jumped to.

j is a convenience wrapper function around autojump. Any option that can be used with autojump can be used with j and vice versa.

• Jump To A Directory That Contains foo:

  j foo
  

• Jump To A Child Directory:

  Sometimes it's convenient to jump to a child directory (sub-directory of current directory) rather than typing out the full name.

  jc bar
  

• Open File Manager To Directories (instead of jumping):

  Instead of jumping to a directory, you can open a file explorer window (Mac Finder, Windows Explorer, GNOME Nautilus, etc.) to the directory instead.

  jo music
  

  Opening a file manager to…

ngrok is a reverse proxy that creates a secure tunnel from a public endpoint to a locally running web service. ngrok captures and analyzes all traffic over the tunnel for later inspection and replay.

ngrok 2.x is the successor to 1.x and the focus of all current development effort. Its source code is not available.

NOTE This repository contains the code for ngrok 1.x.

ngrok 1.x is no longer developed, supported or maintained by its author, except to ensure that the project continues to compile. The contribution policy has the following guidelines:

1. All issues against this repository will be closed unless they demonstrate a crash or other complete failure of ngrok's functionality.
2. All issues against…

hub is a command line tool that wraps git in order to extend it with extra features and commands that make working with GitHub easier.

For an official, potentially more user-friendly command-line interface to GitHub see cli.github.com and this comparison.

This repository and its issue tracker is not for reporting problems with GitHub.com web interface. If you have a problem with GitHub itself, please contact Support.

$ hub clone rtomayko/tilt
#=> git clone https://github.com/rtomayko/tilt.git

# or, if you prefer the SSH protocol:
$ git config --global hub.protocol ssh
$ hub clone rtomayko/tilt
#=> git clone git@github.com:rtomayko/tilt.git

See usage examples or the full reference documentation to see all available commands and flags.

hub can also be used to make shell scripts that directly interact with the GitHub API.

hub can be safely aliased as git, so you can type $ git <command> in the…

A starter project to build command-line tools in Kotlin Multiplatform

Contains a re-implementation of a real world CLI tool: git-standup

You can install using one of the options listed below

Being able to write your own command-line tools is a great skill to have. Automate all the things!

You can write the CLI tools in Kotlin and reap the benefits of using

• a modern programming language
• modern IDE support
• modern practices such as unit testing and continuous integration
• leverage Kotlin multiplatform libraries
• run your code on the JVM and benefit from a wealth of Java libraries
• or build a native executable, which starts very fast and…

^{Special thanks to:}

Warp is a modern, Rust-based terminal with AI built in so you and your team can build great software, faster.

^{Visit warp.dev to learn more.}

---

Maintenance of this project is made possible by all the contributors and sponsors. If you'd like to sponsor this project and have your avatar or company logo appear below click here. 💙

Rant time: You've heard it before, git is powerful, but what good is that power when everything is so damn hard to do? Interactive rebasing requires you to edit a goddamn TODO file in your editor? Are you kidding me? To stage part of a file you need to use a command line program to step through each hunk and if a hunk can't be split down any further but contains code you don't want to stage…

just is a handy way to save and run project-specific commands.

This readme is also available as a book.

(中文文档在 这里 快看过来!)

Commands, called recipes, are stored in a file called justfile with syntax inspired by make:

You can then run them with just RECIPE:

$ just test-all
cc *.c -o main
./test --all
Yay, all your tests passed!

just has a ton of useful features, and many improvements over make:

• just is a command runner, not a build system, so it avoids much of make's complexity and idiosyncrasies No need for .PHONY recipes!

• Linux, MacOS, and Windows are supported with no additional dependencies (Although if your system doesn't have an sh, you'll need to choose a different shell.)

• Errors are specific and informative, and syntax errors are reported along with their source context.

• …

[releases]

Jump integrates with your shell and learns about your navigational habits by keeping track of the directories you visit. It gives you the most visited directory for the shortest search term you type.

Jump comes in packages for the following platforms.

You are using Jump through its shell helper function, j. To get it, you have to integrate Jump with your shell.

Add the line below in ~/.bashrc, ~/bash_profile or ~/.zshrc:

eval "$(jump shell)"

Add the line below in…