How to install pmy on Ubuntu?

First, install Go and a fuzzy finder like fzf via your package manager. Then, use 'go get -u github.com/relastle/pmy' or download the binary from releases, and add 'eval "$(pmy init)"' to your .zshrc to enable it.

pmy vs zsh-autocomplete: which is better for custom completions?

pmy excels with fuzzy-finder-driven, JSON/YAML-based rules for users who prefer easy customization, while zsh-autocomplete is more integrated with native zsh features but has a steeper learning curve. Choose pmy for simplicity and fuzzy finder integration.

How to create a custom rule for git commands in pmy?

Define a rule in a JSON or YAML file with regexp-left matching git patterns, cmd-groups for executing git commands, and save it as git_pmy_rules.json in the PMY_RULE_PATH. Refer to the gallery examples for inspiration.

Can pmy work with peco instead of fzf?

Yes, pmy supports multiple fuzzy finders. You can set the fuzzyFinderCmd in your rules to use peco, or configure the PMY_FUZZY_FINDER_DEFAULT_CMD environment variable to default to peco, as mentioned in the dependency section.

Does pmy slow down shell performance?

Since pmy executes commands and fuzzy finders on the fly without caching, it might introduce latency, especially with complex rules or large outputs. The README notes caching is a missing feature that could mitigate this.

How to change the trigger key from Ctrl+Space to Tab?

Set the PMY_TRIGGER_KEY environment variable to '^I' in your .zshrc before running 'eval "$(pmy init)"'. This will use the tab key, and if no rule matches, it falls back to zsh's default completion, similar to fzf's kill command.

pmy — Context-Aware Zsh Completion Engine

What is pmy?

pmy is a context-aware completion engine for the zsh shell that uses fuzzy finders like fzf to provide intelligent command-line suggestions. It solves the complexity of zsh's native completion system by allowing users to define custom rules via JSON or YAML configurations, making shell interactions faster and more intuitive.

Target Audience

zsh users, command-line power users, and developers who want to enhance their shell productivity with customizable, fuzzy-finder-driven completions.

Value Proposition

Developers choose pmy for its simplicity and flexibility—it replaces zsh's intricate completion system with an easy-to-configure, fuzzy-finder-based approach, enabling highly tailored command-line workflows without deep shell scripting knowledge.

:rocket: General purpose context-aware zsh completion engine powered by fuzzy finder.

Use Cases

Best For

Creating custom command completions for specific tools like git or tmux
Enhancing shell productivity with fuzzy-finder-driven path and command suggestions
Simplifying zsh's native completion system for easier customization
Building personalized shell workflows with JSON/YAML-based rules
Integrating multiple fuzzy finders (fzf, peco, fzy) into zsh completions
Speeding up command-line navigation with context-aware suggestions

Not Ideal For

Shell users who prioritize minimal dependencies and avoid installing Go or fuzzy finders
Teams using bash, fish, or other shells exclusively, as pmy is zsh-specific
Projects requiring advanced zsh completion features like caching or rule prioritization, which pmy lacks
Environments where script-based configuration is preferred over JSON/YAML file management

Pros & Cons

Pros

Context-Aware Rules

Completion triggers based on regex patterns matching the command-line buffer, enabling precise, intelligent suggestions for specific contexts, as shown in the rule examples for git and path completion.

Fuzzy Finder Integration

Seamlessly works with popular fuzzy finders like fzf, peco, or fzy, providing an intuitive selection interface that enhances command-line navigation, as highlighted in the dependency and configuration sections.

Flexible Rule Configuration

Uses simple JSON or YAML files for defining rules, with environment variables for customization, making it easy to tailor completions without deep shell scripting knowledge, as demonstrated in the basic usage and rule configuration.

Command-Specific Optimization

Supports dedicated rule files for commands like git or cd, improving performance and organization by reducing search time, as explained in the command-specific rule section.

Cons

Missing Key Features

The README explicitly states that caching of compiled regular expressions and customizing rule priorities are not yet implemented, which could lead to performance issues and limited flexibility in complex setups.

Setup Complexity

Requires installation of Go and a fuzzy finder, plus writing regex-based rules, which adds overhead and might be daunting for users unfamiliar with these tools, despite the aim of simplifying zsh completion.

Zsh-Only Limitation

Designed exclusively for zsh, so it cannot be used with other shells like bash or fish, restricting its utility in mixed or non-zsh environments, as noted in the project description.

What is pmy?

Target Audience

zsh users, command-line power users, and developers who want to enhance their shell productivity with customizable, fuzzy-finder-driven completions.

Value Proposition

Use Cases

Best For

Creating custom command completions for specific tools like git or tmux
Enhancing shell productivity with fuzzy-finder-driven path and command suggestions
Simplifying zsh's native completion system for easier customization
Building personalized shell workflows with JSON/YAML-based rules
Integrating multiple fuzzy finders (fzf, peco, fzy) into zsh completions
Speeding up command-line navigation with context-aware suggestions

Not Ideal For

Shell users who prioritize minimal dependencies and avoid installing Go or fuzzy finders
Teams using bash, fish, or other shells exclusively, as pmy is zsh-specific
Projects requiring advanced zsh completion features like caching or rule prioritization, which pmy lacks
Environments where script-based configuration is preferred over JSON/YAML file management

Pros & Cons

Pros

Context-Aware Rules

Fuzzy Finder Integration

Flexible Rule Configuration

Command-Specific Optimization

Supports dedicated rule files for commands like git or cd, improving performance and organization by reducing search time, as explained in the command-specific rule section.

Cons

Missing Key Features

Setup Complexity

Zsh-Only Limitation

Designed exclusively for zsh, so it cannot be used with other shells like bash or fish, restricting its utility in mixed or non-zsh environments, as noted in the project description.

pmy

What is pmy?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

pmy

What is pmy?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?