kittens_intro.rst 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. .. _kittens:
  2. Extend with kittens
  3. -----------------------
  4. .. toctree::
  5. :hidden:
  6. :glob:
  7. kittens/icat
  8. kittens/diff
  9. kittens/unicode_input
  10. kittens/themes
  11. kittens/hints
  12. kittens/remote_file
  13. kittens/hyperlinked_grep
  14. kittens/transfer
  15. kittens/ssh
  16. kittens/custom
  17. kittens/*
  18. |kitty| has a framework for easily creating terminal programs that make use of
  19. its advanced features. These programs are called kittens. They are used both to
  20. add features to |kitty| itself and to create useful standalone programs.
  21. Some prominent kittens:
  22. :doc:`icat <kittens/icat>`
  23. Display images in the terminal.
  24. :doc:`diff <kittens/diff>`
  25. A fast, side-by-side diff for the terminal with syntax highlighting and
  26. images.
  27. :doc:`Unicode input <kittens/unicode_input>`
  28. Easily input arbitrary Unicode characters in |kitty| by name or hex code.
  29. :doc:`Themes <kittens/themes>`
  30. Preview and quick switch between over three hundred color themes.
  31. :doc:`Hints <kittens/hints>`
  32. Select and open/paste/insert arbitrary text snippets such as URLs,
  33. filenames, words, lines, etc. from the terminal screen.
  34. :doc:`Remote file <kittens/remote_file>`
  35. Edit, open, or download remote files over SSH easily, by simply clicking on
  36. the filename.
  37. :doc:`Transfer files <kittens/transfer>`
  38. Transfer files and directories seamlessly and easily from remote machines
  39. over your existing SSH sessions with a simple command.
  40. :doc:`Hyperlinked grep <kittens/hyperlinked_grep>`
  41. Search your files using `ripgrep <https://github.com/BurntSushi/ripgrep>`__
  42. and open the results directly in your favorite editor in the terminal,
  43. at the line containing the search result, simply by clicking on the result
  44. you want.
  45. :doc:`Broadcast <kittens/broadcast>`
  46. Type in one :term:`kitty window <window>` and have it broadcast to all (or a
  47. subset) of other :term:`kitty windows <window>`.
  48. :doc:`SSH <kittens/ssh>`
  49. SSH with automatic :ref:`shell integration <shell_integration>`, connection
  50. re-use for low latency and easy cloning of local shell and editor
  51. configuration to the remote host.
  52. :doc:`Panel <kittens/panel>`
  53. Draw a GPU accelerated dock panel on your desktop showing the output from an
  54. arbitrary terminal program.
  55. :doc:`Clipboard <kittens/clipboard>`
  56. Copy/paste to the clipboard from shell scripts, even over SSH.
  57. You can also :doc:`Learn to create your own kittens <kittens/custom>`.