Skip to main content

A command-line snippets manager.

Project description

clisnips

clisnips is a command-line snippets manager.

xkcd/tar

It provides a graphical command-line user interface in which you can save, search and recall your commands.

Installation

clisnips requires python 3.11 or higher.

1. Install clisnips

The recommended way is to use pipx:

pipx install clisnips

2. Install shell key-bindings

# For bash
clisnips key-bindings bash
# For zsh
clisnips key-bindings zsh

Then:

  • Either open a new shell or source your shell rc file,
  • and type the Alt+s keyboard shortcut to open the snippets library.

Usage

Clisnips stores snippets in a local SQLite database, using an FTS5 table to enable full-text search. The search input accepts the whole FTS5 full-text query syntax.

Please have a look at the docs for getting started on writing your own snippets.

You may also read the quick-tour, a small TOML file containing some example snippets. You can import it in your snippets database by running:

clisnips import snippets/quick-tour.toml

In addition to its TUI, clisnips comes with a bunch of other subcommands to help you manage your snippets. Please run clisnips --help to read the CLI documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clisnips-0.6.0.tar.gz (75.9 kB view hashes)

Uploaded Source

Built Distribution

clisnips-0.6.0-py3-none-any.whl (116.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page