Skip to content

Publishing and Sharing

There are two ways to share a Clip with others: publish and share.

PublishShare
What it meansUpload the code to the RegistryExpose a running Clip instance to other users
How others use itpinix hub add @scope/name, then run it on their own machineInvoke it remotely through the Cloud Hub, with the Clip running on your machine
Code ownershipThe code is in the Registry; others download and run it themselvesYou keep the code; others can only invoke it
BillingNot directly supportedYou can set per-call pricing (Credit)
  1. Confirm you are logged in

    Terminal window
    pinix registry whoami
    # → @yourscope
  2. Check clip.json

    {
    "name": "@yourscope/my-clip",
    "version": "0.1.0",
    "description": "我的 Clip 做什么",
    "main": "src/index.ts"
    }
  3. Publish

    Terminal window
    pinix registry publish .

After publishing, anyone can install your Clip with pinix hub add @yourscope/my-clip.

Sharing is done in the Console:

  1. Open the Sharing page in the Console
  2. Select the local Clip that is currently running
  3. Set the share name, tags, description, and access mode
  4. Publish

After sharing, your Clip appears in the Marketplace if you choose public mode. Other users can Add and use it, and invocation requests are routed through the Cloud Hub to your daemon.

ModeDescription
publicVisible in the Marketplace; anyone can add it
unlistedNot shown in the Marketplace, but accessible to anyone with the link
privateRequires authorization to access
tokenRequires a share token to subscribe

Shared Clips can set a price for each invocation, priced in Credit. Each time a user invokes the Clip, you receive the corresponding Credit.