kittens_intro.rst 2.5 KB

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