# clisnips
clisnips is a command-line snippets manager.
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](https://pypa.github.io/pipx/):
```sh
pipx install clisnips
```
### 2. Install shell key-bindings
```sh
# 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][fts5-ref].
Please have a look at [the docs][docs-folder] for getting started on
[writing your own snippets][creating-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:
```sh
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.
[quick-tour]: https://github.com/ju1ius/clisnips/blob/master/snippets/quick-tour.toml
[docs-folder]: https://github.com/ju1ius/clisnips/blob/master/docs/
[creating-snippets]: https://github.com/ju1ius/clisnips/blob/master/docs/creating-snippets.md
[fts5-ref]: https://www.sqlite.org/fts5.html#full_text_query_syntax
Raw data
{
"_id": null,
"home_page": "https://github.com/ju1ius/clisnips",
"name": "clisnips",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "snippet,snippets,cli,tui",
"author": "ju1ius",
"author_email": "jules.bernable@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/83/4b/1257f2f92af7d018dced63861676eec12c6f9e234400ef2f6639425c4ef3/clisnips-0.6.0.tar.gz",
"platform": null,
"description": "# clisnips\n\n\nclisnips is a command-line snippets manager.\n\n\n\nIt provides a graphical command-line user interface in which you can save, search and recall your commands.\n\n\n## Installation\n\nclisnips requires python 3.11 or higher.\n\n### 1. Install clisnips\n\nThe recommended way is to use [pipx](https://pypa.github.io/pipx/):\n```sh\npipx install clisnips\n```\n\n### 2. Install shell key-bindings\n\n```sh\n# For bash\nclisnips key-bindings bash\n# For zsh\nclisnips key-bindings zsh\n```\n\nThen:\n* Either open a *new* shell or source your shell rc file,\n* and type the `Alt+s` keyboard shortcut to open the snippets library.\n\n## Usage\n\nClisnips stores snippets in a local SQLite database,\nusing an FTS5 table to enable full-text search.\nThe search input accepts the whole [FTS5 full-text query syntax][fts5-ref].\n\nPlease have a look at [the docs][docs-folder] for getting started on\n[writing your own snippets][creating-snippets].\n\nYou may also read the [quick-tour][],\na small TOML file containing some example snippets.\nYou can import it in your snippets database by running:\n```sh\nclisnips import snippets/quick-tour.toml\n```\n\nIn addition to its TUI, clisnips comes with a bunch of other subcommands\nto help you manage your snippets. Please run `clisnips --help` to read the CLI documentation.\n\n\n[quick-tour]: https://github.com/ju1ius/clisnips/blob/master/snippets/quick-tour.toml\n[docs-folder]: https://github.com/ju1ius/clisnips/blob/master/docs/\n[creating-snippets]: https://github.com/ju1ius/clisnips/blob/master/docs/creating-snippets.md\n[fts5-ref]: https://www.sqlite.org/fts5.html#full_text_query_syntax\n",
"bugtrack_url": null,
"license": "GPL-3.0+",
"summary": "A command-line snippets manager.",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/ju1ius/clisnips",
"Repository": "https://github.com/ju1ius/clisnips"
},
"split_keywords": [
"snippet",
"snippets",
"cli",
"tui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8c4a6e7120d855f9ca652eb09d7fcafb790d633fde81c1b872fe39789cc91058",
"md5": "e3892377c1265e6e5071d0a87cb281e8",
"sha256": "d2ddcb7a594bf564c6bf2d4cc5c118dcacd49e681c4868e6e703a46cf771e119"
},
"downloads": -1,
"filename": "clisnips-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e3892377c1265e6e5071d0a87cb281e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 116236,
"upload_time": "2023-11-24T13:25:50",
"upload_time_iso_8601": "2023-11-24T13:25:50.886247Z",
"url": "https://files.pythonhosted.org/packages/8c/4a/6e7120d855f9ca652eb09d7fcafb790d633fde81c1b872fe39789cc91058/clisnips-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "834b1257f2f92af7d018dced63861676eec12c6f9e234400ef2f6639425c4ef3",
"md5": "99d22525120f1d29c0efa36af70e69dc",
"sha256": "a80c4c9af6adaa83fe23043347101ebab1146dc09f7a5af169bfa925187f7aa5"
},
"downloads": -1,
"filename": "clisnips-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "99d22525120f1d29c0efa36af70e69dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 75897,
"upload_time": "2023-11-24T13:25:52",
"upload_time_iso_8601": "2023-11-24T13:25:52.764494Z",
"url": "https://files.pythonhosted.org/packages/83/4b/1257f2f92af7d018dced63861676eec12c6f9e234400ef2f6639425c4ef3/clisnips-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-24 13:25:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ju1ius",
"github_project": "clisnips",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "clisnips"
}
JSON
