From b172b487fdfc962f25490eb53ccf6dbbe312b91f Mon Sep 17 00:00:00 2001 From: Hassan Raza Date: Fri, 14 Aug 2026 12:25:02 +0500 Subject: [PATCH] Fix builtin kitten development guide --- docs/kittens/developing-builtin-kittens.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/kittens/developing-builtin-kittens.rst b/docs/kittens/developing-builtin-kittens.rst index e5ba9fa03..78117e644 100644 --- a/docs/kittens/developing-builtin-kittens.rst +++ b/docs/kittens/developing-builtin-kittens.rst @@ -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::