Reference
Package reference
Every package type, the files it needs, and where AWORG installs it.
Types
| Type | Recognised by | Name comes from | Installs to | Install as |
|---|---|---|---|---|
| Skill | SKILL.md | frontmatter name | ~/.aworg/skills/<name>/ | aworg get skills/<name> |
| Tool | __init__.py + tool files | folder name | ~/.aworg/capabilities/<name>/ | aworg get tools/<name> |
| Persona | PERSONA.md | frontmatter name | ~/.aworg/personas/<name>/ | aworg get personas/<name> |
| Snapshot | not open yet |
All three take effect in a running Aworg without a restart. If a zip has more than one of these, SKILL.md wins, then PERSONA.md, then __init__.py.
Frontmatter fields (skills and personas)
| Field | Required | Meaning |
|---|---|---|
name | yes | The package name. |
description | yes | The one-line summary. For a skill, this is what the Resident reads to decide whether to use it. |
version | no | X.Y.Z. |
license | no | Shown on the package page, for example MIT or CC-BY-4.0. |
homepage | no | An https:// link. |
A README.md in the package, if there is one, is shown on the package page instead of the body.
Tool constants
In __init__.py: LABEL, DESCRIPTION, and optionally VERSION, LICENSE, HOMEPAGE.
In each tool file: NAME, DESCRIPTION, INPUT_SCHEMA, and async def run(context, **arguments) -> ToolResult. See Build a tool.
The downloaded zip
Always one folder, named after the package, holding exactly the files listed on the package page:
weather-1.0.0.zip
weather/
__init__.py
get_weather.pyUnzip it into the directory in the table above.