Skip to content

Commit c8a20db

Browse files
committed
Start documenting the choose-files kitten
1 parent 94e6f24 commit c8a20db

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/kittens/choose-files.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,25 @@ Selecting files, fast
66
Overview
77
--------------
88

9+
.. versionadded:: 0.43.0
10+
11+
The choose-files kitten is designed to allow you to select files, very fast,
12+
with just a few key strokes. It operates like `fzf
13+
<https://github.com/junegunn/fzf/>`__ and similar fuzzy finders, except that
14+
it is specialised for finding files. As such it supports features such as
15+
filtering by file type, file type icons, content previews (coming soon) and
16+
so on, out of the box. It can be used as a drop in (but much more efficient and
17+
keyboard friendly) replacement for the :guilabel:`File open and save`
18+
dialog boxes common to GUI programs. On Linux, with the help of the
19+
:doc:`desktop-ui </kittens/desktop-ui>` kitten, you can even convince
20+
most GUI programs on your computer to use this kitten instead of regular file
21+
dialogs.
22+
23+
Simply run it as::
24+
25+
kitten choose-files
26+
27+
to select a single file from the tree rooted at the current working directory.
928

1029
Configuration
1130
------------------------

kittens/choose_files/main.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,10 @@ def main(args: list[str]) -> None:
149149

150150

151151
help_text = '''\
152+
Select one or more files, quickly, using fuzzy finding, by typing just a few characters from
153+
the file name. Browse matching files, using the arrow keys to navigate matches and press :kbd:`Enter`
154+
to select. The :kbd:`Tab` key can be used to change to a sub-folder. See the :doc:`online docs </kittens/choose-files>`
155+
for full details.
152156
'''
153157

154158

0 commit comments

Comments
 (0)