Skip to content

snake46/marker

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Marker

marker

Marker is a command palette for the terminal. It lets you bookmark commands (or commands templates) and easily retreive them with the help of a real-time fuzzy matcher.

It's also shipped with many commands common usage (thanks to tldr).

After installation, all commands have to be stored in the folder ~/.local/share/marker/, including the tldr commands. All new commands, bookmarked with Ctrl-k will be stored in the file /.local/share/marker/bookmarked_commands.txt.

Features:

  • A UI selector that lets you easily select the desired command if more than one command is matched.
  • Fuzzy matching (through commands and their descriptions).
  • Command template that allows to bookmark commands with place-holders and place the cursor at those place-holders using a keyboard shortcut.
  • Portability across supported shells: you can use bookmarked commands in both Bash and Zshell.

Usage

  • Ctrl-space: Search for commands that match the current written string in the command-line
  • Ctrl-k (or marker add): Bookmark a command
  • Ctrl-t: Place the cursor at the next placeholder, identified by '{{anything}}'
  • Ctrl-g: Copy to clipboard you just selected - it requires xsel installed

You can customize key binding using environment variables, respectively with MARKER_KEY_GET, MARKER_KEY_MARK, MARKER_KEY_NEXT_PLACEHOLDER and MARKER_KEY_COPY.

Requirements

  • python 2.7+ or 3.0+
  • Bash 4.3+ or Zsh
  • Linux or OSX
  • xsel by Conrad Parker

##Note: I have not tested this forked version on macOS. The original version of the tool, however, mentioned that: in OSX, it seems like Bash 3.x is the default shell which is not supported. you have to update your Bash to 4.3+ or change your shell to zshell in order to use Marker.

Installation

  • mkdir ~/.marker && cd ~/.marker or go wherever you want to install Marker
  • git clone the repository to the current working directory
  • ./install.py
  • apt-get install xsel to install xsel, in order to use the Ctrl-g feature
  • mv ./tldr ~/.local/share/marker/ to copy the commands within the tldr folder into the marker home folder where all the commands need to be added

License

MIT

About

The terminal command palette

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 80.2%
  • Shell 19.8%