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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file clisnips-0.6.0.tar.gz.

File metadata

  • Download URL: clisnips-0.6.0.tar.gz
  • Upload date:
  • Size: 75.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1016-azure

File hashes

Hashes for clisnips-0.6.0.tar.gz
Algorithm Hash digest
SHA256 a80c4c9af6adaa83fe23043347101ebab1146dc09f7a5af169bfa925187f7aa5
MD5 99d22525120f1d29c0efa36af70e69dc
BLAKE2b-256 834b1257f2f92af7d018dced63861676eec12c6f9e234400ef2f6639425c4ef3

See more details on using hashes here.

File details

Details for the file clisnips-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: clisnips-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 116.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1016-azure

File hashes

Hashes for clisnips-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d2ddcb7a594bf564c6bf2d4cc5c118dcacd49e681c4868e6e703a46cf771e119
MD5 e3892377c1265e6e5071d0a87cb281e8
BLAKE2b-256 8c4a6e7120d855f9ca652eb09d7fcafb790d633fde81c1b872fe39789cc91058

See more details on using hashes here.

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