mirror of
https://github.com/iflytek/skillhub.git
synced 2026-10-09 03:17:52 +00:00
Refresh docs to reflect current project state including new modules and simplified deployment approach.
96 lines
3.5 KiB
Markdown
96 lines
3.5 KiB
Markdown
# SkillHub
|
|
|
|
An enterprise-grade agent skill registry — publish, discover, and
|
|
manage reusable skill packages across your organization.
|
|
|
|
SkillHub is a self-hosted platform that gives teams a private,
|
|
governed place to share agent skills. Publish a skill package, push
|
|
it to a namespace, and let others find it through search or
|
|
install it via CLI. Built for on-premise deployment behind your
|
|
firewall, with the same polish you'd expect from a public registry.
|
|
|
|
## Highlights
|
|
|
|
- **Self-Hosted & Private** — Deploy on your own infrastructure.
|
|
Keep proprietary skills behind your firewall with full data
|
|
sovereignty. One `make dev-all` command to get running locally.
|
|
- **Publish & Version** — Upload agent skill packages with semantic
|
|
versioning, custom tags (`beta`, `stable`), and automatic
|
|
`latest` tracking.
|
|
- **Discover** — Full-text search with filters by namespace,
|
|
downloads, ratings, and recency. Visibility rules ensure
|
|
users only see what they're authorized to.
|
|
- **Team Namespaces** — Organize skills under team or global scopes.
|
|
Each namespace has its own members, roles (Owner / Admin /
|
|
Member), and publishing policies.
|
|
- **Review & Governance** — Team admins review within their namespace;
|
|
platform admins gate promotions to the global scope. Every
|
|
action is audit-logged for compliance.
|
|
- **CLI-First** — Native REST API plus a compatibility layer for
|
|
existing ClawHub CLI tools — no client changes needed.
|
|
- **Pluggable Storage** — Local filesystem for development, S3 /
|
|
MinIO for production. Swap via config.
|
|
|
|
## Quick Start
|
|
|
|
### Prerequisites
|
|
|
|
- Docker & Docker Compose
|
|
|
|
### Local Development
|
|
|
|
```bash
|
|
make dev-all
|
|
```
|
|
|
|
Then open:
|
|
|
|
- Web UI: `http://localhost:3000`
|
|
- Backend API: `http://localhost:8080`
|
|
|
|
Stop everything with:
|
|
|
|
```bash
|
|
make dev-all-down
|
|
```
|
|
|
|
Reset local dependencies and start from a clean slate with:
|
|
|
|
```bash
|
|
make dev-all-reset
|
|
```
|
|
|
|
Run `make help` to see all available commands.
|
|
|
|
## Architecture
|
|
|
|
```
|
|
┌─────────────┐ ┌─────────────┐ ┌──────────────┐
|
|
│ Web UI │ │ CLI Tools │ │ REST API │
|
|
└──────┬──────┘ └──────┬──────┘ └──────┬───────┘
|
|
│ │ │
|
|
└───────────────────┼───────────────────┘
|
|
│
|
|
┌──────▼──────┐
|
|
│ Nginx │
|
|
└──────┬──────┘
|
|
│
|
|
┌──────▼──────┐
|
|
│ Spring Boot │ Auth · RBAC · Core Services
|
|
└──────┬──────┘
|
|
│
|
|
┌────────────┼────────────┐
|
|
│ │ │
|
|
┌──────▼───┐ ┌─────▼────┐ ┌───▼────┐
|
|
│PostgreSQL│ │ Redis │ │ MinIO │
|
|
└──────────┘ └──────────┘ └────────┘
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome. Please open an issue first to discuss
|
|
what you'd like to change.
|
|
|
|
## License
|
|
|
|
MIT
|