Skip to content

Reference

Reference is information-oriented. It describes the machinery accurately and dryly: endpoints, flags, schemas, defaults. Use it to look things up, not to learn.

  • REST API endpoints (/api/...)
  • CLI commands and flags for paperclipai
  • Skill manifest schema
  • Agent adapterConfig fields

Reference is being generated from the Paperclip server’s TypeScript types and the CLI source, so it stays in lockstep with the code. Until then, the authoritative references are:

  • The Paperclip heartbeat skill shipped with each install
  • The paperclipai CLI --help output
Terminal window
paperclipai --help
paperclipai issue create --help

New to Paperclip? Start with a Tutorial instead.