.\" Man page generated from reStructuredText. . . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .TH "kitten-themes" 1 "Oct 30, 2024" "0.37.0" "kitty" .SH Name kitten-themes \- Manage kitty color schemes easily .SH Overview .sp The themes kitten allows you to easily change color themes, from a collection of over three hundred pre\-built themes available at \X'tty: link https://github.com/kovidgoyal/kitty-themes'\fI\%kitty\-themes\fP\X'tty: link'\&. To use it, simply run: .INDENT 0.0 .INDENT 3.5 .sp .EX kitten themes .EE .UNINDENT .UNINDENT .sp The kitten allows you to pick a theme, with live previews of the colors. You can choose between light and dark themes and search by theme name by just typing a few characters from the name. .sp The kitten maintains a list of recently used themes to allow quick switching. .sp If you want to restore the colors to default, you can do so by choosing the \fBDefault\fP theme. .sp Added in version 0.23.0: The themes kitten .SH How it works .sp A theme in kitty is just a \fB\&.conf\fP file containing kitty settings. When you select a theme, the kitten simply copies the \fB\&.conf\fP file to \fB~/.config/kitty/current\-theme.conf\fP and adds an include for \fBcurrent\-theme.conf\fP to \fBkitty.conf\fP\&. It also comments out any existing color settings in \fBkitty.conf\fP so they do not interfere. .sp Once that\(aqs done, the kitten sends kitty a signal to make it reload its config. .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 If you want to have some color settings in your \fBkitty.conf\fP that the theme kitten does not override, move them into a separate conf file and \fBinclude\fP it into kitty.conf. The include should be places after the inclusion of \fBcurrent\-theme.conf\fP so that the settings in it override conflicting settings from \fBcurrent\-theme.conf\fP\&. .UNINDENT .UNINDENT .SH Using your own themes .sp You can also create your own themes as \fB\&.conf\fP files. Put them in the \fBthemes\fP sub\-directory of the \fI\%kitty config directory\fP, usually, \fB~/.config/kitty/themes\fP\&. The kitten will automatically add them to the list of themes. You can use this to modify the builtin themes, by giving the conf file the name \fBSome theme name.conf\fP to override the builtin theme of that name. Here, \fBSome theme name\fP is the actual builtin theme name, not its file name. Note that after doing so you have to run the kitten and choose that theme once for your changes to be applied. .SH Contributing new themes .sp If you wish to contribute a new theme to the kitty theme repository, start by going to the \X'tty: link https://github.com/kovidgoyal/kitty-themes'\fI\%kitty\-themes\fP\X'tty: link' repository. \X'tty: link https://docs.github.com/en/get-started/quickstart/fork-a-repo'\fI\%Fork it\fP\X'tty: link', and use the file \fBtemplate.conf\fP as a template when creating your theme. Once you are satisfied with how it looks, \X'tty: link https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request'\fI\%submit a pull request\fP\X'tty: link' to have your theme merged into the \X'tty: link https://github.com/kovidgoyal/kitty-themes'\fI\%kitty\-themes\fP\X'tty: link' repository, which will make it available in this kitten automatically. .SH Changing the theme non-interactively .sp You can specify the theme name as an argument when invoking the kitten to have it change to that theme instantly. For example: .INDENT 0.0 .INDENT 3.5 .sp .EX kitten themes \-\-reload\-in=all Dimmed Monokai .EE .UNINDENT .UNINDENT .sp Will change the theme to \fBDimmed Monokai\fP in all running kitty instances. See below for more details on non\-interactive operation. .SH Source code for themes .sp The source code for this kitten is \X'tty: link https://github.com/kovidgoyal/kitty/tree/master/kittens/themes'\fI\%available on GitHub\fP\X'tty: link'\&. .SH Command line interface .INDENT 0.0 .INDENT 3.5 .sp .EX kitten themes [options] [theme name to switch to] .EE .UNINDENT .UNINDENT .sp Change the kitty theme. If no theme name is supplied, run interactively, otherwise change the current theme to the specified theme name. .SS Options .INDENT 0.0 .TP .B \-\-cache\-age Check for new themes only after the specified number of days. A value of zero will always check for new themes. A negative value will never check for new themes, instead raising an error if a local copy of the themes is not available. Default: \fB1\fP .UNINDENT .INDENT 0.0 .TP .B \-\-reload\-in By default, this kitten will signal only the parent kitty instance it is running in to reload its config, after making changes. Use this option to instead either not reload the config at all or in all running kitty instances. Default: \fBparent\fP Choices: \fBall\fP, \fBnone\fP, \fBparent\fP .UNINDENT .INDENT 0.0 .TP .B \-\-dump\-theme When running non\-interactively, dump the specified theme to STDOUT instead of changing kitty.conf. Default: \fBfalse\fP .UNINDENT .INDENT 0.0 .TP .B \-\-config\-file\-name The name or path to the config file to edit. Relative paths are interpreted with respect to the kitty config directory. By default the kitty config file, kitty.conf is edited. This is most useful if you add \fBinclude themes.conf\fP to your kitty.conf and then have the kitten operate only on \fBthemes.conf\fP, allowing \fBkitty.conf\fP to remain unchanged. Default: \fBkitty.conf\fP .UNINDENT .SH Author Kovid Goyal .SH Copyright 2024, Kovid Goyal .\" Generated by docutils manpage writer. .