pats / registry

Appearance

Create your Pat ​

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

1. Scaffold the project ​

In the directory where you keep your projects, run:

bash
kirn new pats my-pat
cd my-pat

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

text
.github/workflows/kirn-pats-release.yml

Do not copy the workflow into the registry repository. It belongs to the Pat'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:

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

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