Create your Pet

A Pet belongs in its own repository. The registry repository does not hold Pet source code.

1. Scaffold the project

In the directory where you keep your projects, run:

kirn new pets my-pet
cd my-pet

The command creates a hello-world Pet template and initializes the Auto Build & Release workflow in your project:

.github/workflows/kirn-pets-release.yml

Do not copy the workflow into the registry repository. It belongs to the Pet's own repository.

2. Make it useful

Replace the template with your package and keep the project easy to inspect:

• Give it a unique, lowercase name.
• Document installation and usage in README.md.
• Keep the package metadata accurate.
• Add tests and a small runnable example.
• Include an open-source license.
• Do not commit secrets, generated credentials, or unrelated files.

3. Check the manifest

Review kirn.toml before publishing:

[package]
name = "my-pet"
version = "0.1.0"
type = "lib"
license = "MIT"
author = "Your Name"
description = "A short description of the Pet."

Use the exact manifest shape generated by your installed Kirn version; this example is illustrative.