CERBERUS/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty.git synced 2026-09-02 23:33:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fix builtin kitten development guide

Browse source
This commit is contained in:
Hassan Raza 2026-08-14 12:25:02 +05:00
parent d9610f5e1e
commit b172b487fd
No known key found for this signature in database
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/kittens/developing-builtin-kittens.rst
View file

@ -10,7 +10,7 @@ Getting started
To get started with creating a builtin kitten, one that will become part of kitty
and be available as ``kitten my-kitten``, create a directory named
:file:`my_kitten` in the :file:`kittens` directory. Then, in this directory
add three, files: :file:`__init__.py` (an empty file), :file:`__main__.py` and
add three files: :file:`__init__.py` (an empty file), :file:`main.py` and
:file:`main.go`.
Template for `main.py`
@ -67,7 +67,7 @@ The file :file:`main.py` contains the command line option definitions for your k
# The usage string for your kitten
usage = 'TITLE [BODY ...]'
short_description = 'some short description of your kitten it will show up when running kitten without arguments to list all kittens`
short_description = 'A short description of your kitten'
if __name__ == '__main__':
raise SystemExit('This should be run as kitten my-kitten')
@ -89,7 +89,7 @@ Template for `main.go`
import (
"fmt"
"kitty/tools/cli"
"github.com/kovidgoyal/kitty/tools/cli"
)
var _ = fmt.Print
@ -111,7 +111,7 @@ Edit :file:`tools/cmd/tool/main.go`
Add the entry point of the kitten into :file:`tools/cmd/tool/main.go`.
First, import the kitten into this file. To do this, add :code:`"kitty/kittens/my_kitten"` into the :code:`import ( ... )` section at the top.
First, import the kitten into this file. To do this, add :code:`"github.com/kovidgoyal/kitty/kittens/my_kitten"` into the :code:`import ( ... )` section at the top.
Then, add ``my_kitten.EntryPoint(root)`` into ``func KittyToolEntryPoints(root *cli.Command)`` and you are done. After running make you should
be able to test your kitten by running::