Skip to content

leefanv/uiskill

Repository files navigation

uiskill

uiskill.sh — A standardized schema to abstract B2B SaaS UI patterns into executable skills for AI Agents.

Packages

Package npm Description
@uiskill/core npm install @uiskill/core Core protocol and schema definitions
uiskill npx uiskill CLI for installing and publishing skills

Architecture

┌─────────────────────────────────────────────────────────┐
│  uiskill-core (this repo)                               │
│                                                         │
│  packages/core   → @uiskill/core   SDK & schema         │
│  packages/cli    → uiskill         CLI tool             │
└──────────────┬──────────────────────┬───────────────────┘
               │ npm install          │ API calls
               ▼                      ▼
┌──────────────────────┐   ┌─────────────────────────────┐
│  Skill developers    │   │  platform (uiskill.sh)      │
│                      │   │                             │
│  Use @uiskill/core   │   │  Skill registry & API       │
│  to define skills,   │──▶│  Stores skill specs in DB   │
│  use CLI to publish  │   │  Serves download requests   │
│  and install         │   │  Web UI for browsing        │
└──────────────────────┘   └─────────────────────────────┘

uiskill-core provides developer tools (SDK + CLI), published to npm. platform is the hosted registry at uiskill.sh, where skills are stored and distributed.

Skills are JSON spec files — not code packages. The platform stores them in a database, and the CLI fetches them via the platform API.

Environments

Platform

Environment URL Purpose
Production https://uiskill.sh Stable, user-facing
Staging https://test.uiskill.sh Pre-release testing

The CLI defaults to production. Switch with:

uiskill config set registry https://test.uiskill.sh   # staging
uiskill config set registry https://uiskill.sh         # production (default)

npm Releases

Releases are triggered by git tags:

Tag format npm tag Example Use case
v1.0.0 latest npm install uiskill Stable release
v1.0.0-beta.1 beta npm install uiskill@beta Pre-release testing
# Pre-release — publishes to npm beta, creates GitHub prerelease, does NOT notify platform
git tag v0.2.0-beta.1
git push --tags

# Stable release — publishes to npm latest, creates GitHub release, notifies platform to update
git tag v0.2.0
git push --tags

Cross-repo Workflow

When a stable version is released from this repo:

  1. GitHub Actions builds and publishes @uiskill/core + uiskill to npm
  2. A repository_dispatch event notifies the platform repo
  3. Platform repo automatically creates a PR to update @uiskill/core to the new version
  4. Review and merge the PR to complete the update

Pre-release (beta) tags skip step 2–4 — the platform is only updated on stable releases.

Required Secrets (uiskill-core repo)

Secret Purpose
NPM_TOKEN npm publish token
PLATFORM_DISPATCH_TOKEN GitHub PAT with contents:write on the platform repo

CLI Usage

# Login with your API token (from uiskill.sh dashboard)
uiskill login <token>

# Install a skill into your project
uiskill install @scope/skill-name

# Publish a skill spec
uiskill publish path/to/spec.json --scope my-namespace

# View current config
uiskill config get

Installed skills are stored in .uiskill/ in your project directory:

your-project/
  .uiskill/
    manifest.json              # Tracks installed skills and versions
    skills/
      scope__skill-name.json   # Downloaded skill spec

Links

About

Bridging SaaS UI to AI Agent Skills — discover, share, and install reusable UI skills for AI agents.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors