Files
zpan/docs/agent-skill.md
T
agent-kanban[bot] e50c19051a docs: publish ZPan Agent Skill (#543)
* docs: publish zpan agent skill

Agent-Profile: https://agent-kanban.dev/agents/b0abe6cd7aeba133

* test: cover openapi auth route metadata

Agent-Profile: https://agent-kanban.dev/agents/b0abe6cd7aeba133

* fix: align zpan skill restish commands

Agent-Profile: https://agent-kanban.dev/agents/b0abe6cd7aeba133

* docs: clarify zpan skill release boundaries

* docs: align zpan upload profile examples

Agent-Profile: https://agent-kanban.dev/agents/b0abe6cd7aeba133

* fix: select upload plugin profile via environment

* fix: return zpan upload plugin help

Agent-Profile: https://agent-kanban.dev/agents/b0abe6cd7aeba133

---------

Co-authored-by: Noah Reed <noah-reed@mails.agent-kanban.dev>
Co-authored-by: saltbo <saltbo@foxmail.com>
2026-07-29 20:19:16 -04:00

1.6 KiB

ZPan Agent Skill

ZPan v2.9 publishes a versioned Agent Skill in skills/zpan. The Skill teaches coding agents to use ZPan through Restish and the restish-zpan upload plugin.

Install and Connect

Install Restish v2.3 or later, confirm the ZPan origin, then connect the single unified OpenAPI document:

restish api connect zpan https://files.example.com/api/openapi.json --replace --yes
restish api sync zpan

Interactive agents use browser OAuth authorization code + PKCE through Restish. CI and unattended jobs use the ci profile with ZPAN_AGENT_API_KEY from the environment.

Upload Plugin

Before installing the plugin, tell the user that Restish plugins are trusted local executable code and ask them to approve the source:

restish plugin install saltbo/zpan zpan

Every local upload goes through:

RSH_PROFILE=file-manager restish zpan-upload --api zpan --profile file-manager --parent root ./file.bin

The Skill does not implement upload transport logic. The plugin owns local file streaming, storage response capture, retry, resume, abort, and checkpoint cleanup.

Profiles

  • reader: read objects, shares, quota, and storage usage.
  • file-manager: reader plus create, upload, move, copy, rename, and soft delete objects.
  • publisher: reader plus public share creation and revocation.
  • ci: environment-backed Agent API key for unattended file-management jobs.

The profile names are shortcuts for explicit scopes. They are not server-side roles and routes do not authorize by preset name.

Interactive Restish login uses browser OAuth authorization code + PKCE.