Install and Use Zsh Autosuggestions Plugin: 3 Easy Steps

This guide is designed to teach you how to Install and Use Zsh Autosuggestions Plugin on Linux. Zsh, also known as the Z shell, is a powerful shell environment available on Linux and Unix-based operating systems. Its strength lies in its extensive plugin support, offering a level of customization unmatched by many other shell tools. This, combined with other performance enhancements, makes Zsh a notably fast and efficient shell.

One of the most popular and useful frameworks for managing Zsh configurations is Oh My Zsh. This framework simplifies the process of installing and managing various plugins and themes. Among these plugins, Zsh Autosuggestions stands out. Its primary function is to suggest commands based on your command history and the commands you are currently typing, significantly speeding up your workflow and reducing the likelihood of errors.

In this guide from Orcacore, we’ll walk you through the simple steps to Install and Use Zsh Autosuggestions Plugin. We’ll also discuss alternative methods to achieve similar command suggestion functionality.

Before you begin to Install and Use Zsh Autosuggestions Plugin, ensure that you have Zsh and the Oh My Zsh framework installed on your Linux server. If you haven’t already done so, you can refer to this guide: Install Zsh and Oh My Zsh on Linux from the Command Line. Once you have these prerequisites in place, you can proceed with the following steps.

Step 1 – Download the Autosuggestions Plugin via GitHub

The recommended method to Install and Use Zsh Autosuggestions Plugin is by cloning it from the Oh My Zsh Git repository. This ensures you have the latest version and can easily update it in the future.

Assuming you have already installed and configured Oh My Zsh, execute the following command to clone the zsh-autosuggestions plugin:

git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions

This command downloads the autosuggestion repository and places it in the designated plugin directory within your Oh My Zsh installation.

Step 2 – Enable the Zsh-Autosuggestions Plugin

After downloading the plugin, you need to enable it by adding it to your ~/.zshrc file. This file contains your Zsh configuration settings. Open the file using your preferred text editor (e.g., Vi, Nano, or VS Code). Here, we use the Vi Editor:

vi ~/.zshrc

Locate the "plugins" section within the ~/.zshrc file. It typically looks similar to this:

Add zsh-autosuggestions to the list of plugins:

plugins=(git)
plugins=(
    zsh-autosuggestions
)
source $ZSH/oh-my-zsh.sh

Ensure your file resembles the following:

Save the changes and close the file.

Step 3 – Using the Zsh Autosuggestions Plugin

To activate the plugin, you need to either restart your terminal session or source the ~/.zshrc file:

source ~/.zshrc

Once the plugin is enabled, it will automatically suggest commands as you type, based on your command history. To accept a suggestion, press the right-arrow key. To ignore the suggestion and continue typing, press the down-arrow key or simply keep typing.

That’s all there is to it! You’ve successfully learned how to Install and Use Zsh Autosuggestions Plugin.

Alternative Solutions for Command Suggestions in Zsh

While the zsh-autosuggestions plugin is a fantastic and widely used solution, there are alternative ways to achieve similar command suggestion functionality in Zsh. Here are two different approaches:

1. Using zsh-history-substring-search

zsh-history-substring-search offers a different approach to command suggestions. Instead of automatically suggesting entire commands, it allows you to search your history for commands containing a specific substring. This is particularly useful when you remember a part of a command but not the whole thing.

Installation and Usage:

1. Clone the repository:

   git clone https://github.com/zsh-users/zsh-history-substring-search ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-history-substring-search

2. Enable the plugin in ~/.zshrc:

   Add zsh-history-substring-search to the plugins list in your ~/.zshrc file, similar to how you enabled zsh-autosuggestions.

   plugins=(
       git
       zsh-history-substring-search
   )

3. Source the ~/.zshrc file or restart your terminal:

   source ~/.zshrc

How it works:

After installation, start typing a part of a command you remember. Then, use the up and down arrow keys to cycle through matching commands from your history. The matched substring will be highlighted.

Example:

Let’s say you want to find a command that involved "docker compose". Start typing docker compose and then press the up arrow key. The plugin will search your history for commands containing that substring and display the most recent one. Pressing the up arrow key repeatedly will cycle through older matches.

2. Leveraging Zsh’s Built-in Completion System with Customizations

Zsh has a powerful built-in completion system that can be customized to provide suggestions based on various factors, including command history, available commands, and even file contents. While it doesn’t offer the same out-of-the-box experience as zsh-autosuggestions, it offers greater flexibility and control.

Customizing Zsh’s Completion System:

1. Modify your ~/.zshrc file:

   You can add custom completion functions to your ~/.zshrc file to tailor the completion behavior to your specific needs.

   Example:

   The following example demonstrates how to create a custom completion for a hypothetical command called mycommand:

   _mycommand() {
     local -a commands
     commands=(
       "option1:Description of option1"
       "option2:Description of option2"
       "option3:Description of option3"
     )
     _describe 'command' commands
   }
   
   compdef _mycommand mycommand

   Explanation:

   • _mycommand(): This is the completion function for the mycommand command.
   • local -a commands: This declares an array called commands to store the available options for the command.
   • _describe 'command' commands: This uses the _describe function to generate the completion suggestions based on the commands array. The 'command' argument specifies the type of completion (in this case, a command option).
   • compdef _mycommand mycommand: This associates the _mycommand completion function with the mycommand command.

2. Source the ~/.zshrc file or restart your terminal:

   source ~/.zshrc

How it works:

After adding the custom completion function, when you type mycommand and press the Tab key, Zsh will display the available options (option1, option2, option3) along with their descriptions.

Benefits of Custom Completion:

• Flexibility: You can create highly specific completions tailored to your commands and workflows.
• Control: You have fine-grained control over the completion behavior.
• Integration: You can integrate completions with external data sources (e.g., files, databases).

Limitations:

• Complexity: Creating custom completions can be more complex than using pre-built plugins.
• Maintenance: You are responsible for maintaining your custom completions.

Conclusion

This guide has provided a detailed walkthrough on how to Install and Use Zsh Autosuggestions Plugin, a valuable tool for enhancing your command-line productivity. We covered the installation process, enabling the plugin, and basic usage. Additionally, we explored two alternative methods for achieving command suggestion functionality in Zsh: using zsh-history-substring-search and leveraging Zsh’s built-in completion system with customizations. Each method offers a different approach and caters to different preferences and use cases. Choosing the right solution depends on your individual needs and desired level of customization.

You may also be interested in these articles:

Install build-essential on Ubuntu 22.04

Create a Local Repository on AlmaLinux 9

Install Java with Apt on Debian 12 Bookworm