Giter VIP home page Giter VIP logo

palette's Introduction

Palette

A command palette for your operating system.

Demo

Description

Palette holds a list of easy-access commands and when prompted displays a searchable cheat-sheet including the keyboard shortcut each command is bound to.

Usage

Palette runs as a daemon (paletted), and is controlled through palette which communicates with the daemon through a socket.

The program is designed to also manage your keyboard shortcuts for you by creating its own instance of sxhkd with a generated configuration.

Configuring

Palette is configured through a YAML file, with each command containing a description, exec string, an optional keybinding, and optional meta keywords:

description: A string describing the command.
exec: The string to execute with `sh -c EXEC_STRING` whenever the command is run.
keybinding [OPTIONAL]: Keybinding for the command. Note that the syntax for this field is identical to sxhkd's keybinding syntax.
meta [OPTIONAL]: Additional invisible search terms for the command.

For an example configuration, see here.

Paletted

usage: paletted [-h] [-c CONFIG] [-b {none,sxhkd}] [-v] [-V] [--validate] [-s SOCKET]

Daemon process for palette

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Config YAML file path (defaults to "$HOME/.config/palette/palette.yml").
  -b {none,sxhkd}, --backend {none,sxhkd}
                        Backend to use for keybindings management (defaults to "sxhkd")
  -v, --version         Show version number and exit
  -V, --verbose         Enable verbose output
  --validate            Validate configuration file and exit
  -s SOCKET, --socket SOCKET
                        Socket to listen for incoming connections

Palette

usage: palette COMMAND

Controls the Palette daemon by communication with it through a socket.

commands:
    help   - Show this help message and exit.
    show   - Show the command palette.
    quit   - Ask paletted to suicide.
    reload - Reload the configuration YAML file. 
             If a keybindings backend is running, 
             the keybindings will also be updated accordingly.

Requirements

  • rofi

  • bspwm

  • sxhkd

Installation

Install from pypi:

sudo pip3 install commandpalette

Build and install from source:

git clone https://github.com/QazmoQwerty/palette
cd palette
sudo pip3 install -r requirements.txt
python3 -m build
sudo python3 -m pip install dist/commandpalette*.whl

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.