https://github.com/slice-soft/ss-keel-addons
Public addon registry for Keel CLI
https://github.com/slice-soft/ss-keel-addons
addons keel registry slicesoft
Last synced: 25 days ago
JSON representation
Public addon registry for Keel CLI
- Host: GitHub
- URL: https://github.com/slice-soft/ss-keel-addons
- Owner: slice-soft
- License: mit
- Created: 2026-03-06T21:30:09.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-03-25T19:03:46.000Z (3 months ago)
- Last Synced: 2026-03-26T19:38:42.393Z (3 months ago)
- Topics: addons, keel, registry, slicesoft
- Homepage: https://docs.keel-go.dev/en/addons/overview/
- Size: 9.77 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Keel Addons
[](https://github.com/slice-soft/ss-keel-addons)
[](https://github.com/slice-soft/ss-keel-addons)
[](https://github.com/slice-soft/ss-keel-addons/graphs/contributors)
[](https://github.com/sponsors/slice-soft)
`ss-keel-addons` is the public alias registry used by the Keel CLI.
When a developer runs `keel add `, the CLI resolves that alias through this repository and then installs the addon from its source repository.
## What lives in this repository
This repository stores addon metadata only. It does not contain addon implementation code.
Each addon entry in `registry.json` includes:
- `alias`
- `repo`
- `description`
- `source`
- `tags`
## Registry format
`registry.json`:
```json
{
"version": "1",
"addons": [
{
"alias": "gorm",
"repo": "github.com/slice-soft/ss-keel-gorm",
"description": "SQL via GORM — Postgres, MySQL, SQLite, SQL Server",
"source": "slice-soft",
"tags": ["sql", "gorm", "postgres", "mysql", "sqlite", "sqlserver"]
}
]
}
```
Field notes:
- `alias`: Unique short name used with `keel add `.
- `repo`: Public repository/module path where the addon lives.
- `description`: Short summary of the addon.
- `source`: Ownership/source label (for example `slice-soft`, `community`, or a company/org label).
- `tags`: Searchable keywords for discovery.
## `keel add` flow
1. Run `keel add gorm`.
2. The CLI checks this registry for alias `gorm`.
3. The CLI resolves the mapped `repo`.
4. The CLI downloads the addon from that repository.
5. The CLI validates and executes the addon's own integration contract.
## Add or update an alias
1. Fork this repository.
2. Edit `registry.json` with the addon metadata (`alias`, `repo`, `description`, `source`, `tags`).
3. Open a PR in this repository.
4. Include links to your addon repository (and docs/tests evidence in the PR description).
5. Optionally open a docs PR in `ss-keel-docs` and link it.
6. Share the PR in Discord for community/maintainer review.
See [CONTRIBUTING.md](./CONTRIBUTING.md) for the complete repository-specific process.
## Contributing
The base workflow, commit conventions, and community standards live in [ss-community](https://github.com/slice-soft/ss-community/blob/main/CONTRIBUTING.md).
## Community
| Document | |
|---|---|
| [CONTRIBUTING.md](https://github.com/slice-soft/ss-community/blob/main/CONTRIBUTING.md) | Workflow, commit conventions, and PR guidelines |
| [GOVERNANCE.md](https://github.com/slice-soft/ss-community/blob/main/GOVERNANCE.md) | Decision-making, roles, and release process |
| [CODE_OF_CONDUCT.md](https://github.com/slice-soft/ss-community/blob/main/CODE_OF_CONDUCT.md) | Community standards |
| [VERSIONING.md](https://github.com/slice-soft/ss-community/blob/main/VERSIONING.md) | SemVer policy and breaking changes |
| [SECURITY.md](https://github.com/slice-soft/ss-community/blob/main/SECURITY.md) | How to report vulnerabilities |
| [MAINTAINERS.md](https://github.com/slice-soft/ss-community/blob/main/MAINTAINERS.md) | Active maintainers |
## License
MIT License - see [LICENSE](LICENSE) for details.
## Links
- Website: [keel-go.dev](https://keel-go.dev)
- GitHub: [github.com/slice-soft/ss-keel-cli](https://github.com/slice-soft/ss-keel-cli)
- Documentation: [docs.keel-go.dev](https://docs.keel-go.dev)
---
Made by [SliceSoft](https://slicesoft.dev) - Colombia