דילוג לתוכן
  1. תיעוד/

מדריך התקנה

1. התקנת PocketHook
#

הורד את PocketHook מ-App Store ופתח אותו ב-iPhone, iPad או Mac שלך.

2. הגדרת השרת שלך
#

PocketHook צריך נקודת קצה HTTPS לתקשורת. אתה יכול להשתמש ב:

  • שרת Agent — סוכן AI באירוח עצמי עם LLM, כלים, משימות רקע וזיכרון
  • ה-API שלך — כל שרת שמקבל בקשות POST ומחזיר JSON
  • n8n — אוטומציית תהליכי עבודה באירוח עצמי עם טריגר webhook
  • OpenClaw — עוזר AI באירוח עצמי עם הודעות רב-ערוציות

דרישות השרת
#

השרת שלך חייב:

  • לקבל בקשות POST עם גוף JSON
  • להחזיר תגובות JSON
  • להיות נגיש דרך HTTPS (HTTP נדחה מסיבות אבטחה)
  • באופן אופציונלי לתמוך באימות Bearer token

3. חיבור ב-PocketHook
#

  1. פתח את PocketHook ועבור להגדרות
  2. הזן את כתובת URL של השרת (חייבת להיות HTTPS)
  3. הזן את טוקן האימות שלך (אם השרת שלך דורש אימות)
  4. לחץ על בדוק חיבור לאימות

מסך הגדרות PocketHook

4. פורמט בקשה
#

PocketHook שולח הודעות כמערך JSON:

[{
  "sessionId": "uuid-v4",
  "action": "sendMessage",
  "chatInput": "ההודעה שלך כאן"
}]

5. פורמט תגובה
#

השרת שלך צריך להגיב עם אובייקט JSON:

{
  "msg": "הודעה המוצגת למשתמש",
  "shortcut": "שם קיצור דרך אופציונלי",
  "data": { "מפתח": "ערך" },
  "url": "https://optional-url.com"
}
שדהסוגנדרשתיאור
msgstringכןטקסט המוצג בצ’אט
shortcutstringלאקיצור דרך iOS להפעלה
dataobject | arrayלאנתונים המועברים לקיצור הדרך
urlstringלאכתובת URL לפתיחה או הצגה

לאוטומציות מרובות שלבים, החזר מערך של תגובות:

[
  { "msg": "שלב 1...", "shortcut": "קיצור דרך ראשון" },
  { "msg": "שלב 2...", "shortcut": "קיצור דרך שני", "data": { "input": "ערך" } }
]

6. התחלה מהירה עם שרת Starter
#

השתמש בתבנית שרת starter שלנו כדי להתחיל בדקות:

git clone https://github.com/pockethook-app/pockethook-server.git
cd pockethook-server
bun install
cp .env.example .env
# ערוך את .env עם הטוקן הסודי שלך
bun dev

ה-starter כולל פקודות מובנות (ping, hello, help, time) ודוגמאות להפעלת Shortcuts. ראה את הפניית API למפרט הפרוטוקול המלא.

7. שימוש ב-SDK
#

התקן את חבילת pockethook-sdk לבניית תגובות בטוחות טיפוסית:

bun add pockethook-sdk
import { text, shortcut, responses, toResponse } from "pockethook-sdk";

// תגובת טקסט פשוטה
return toResponse(text("שלום מהשרת שלי!"));

// הפעלת קיצור דרך
return toResponse(shortcut("מריץ...", "קיצור הדרך שלי", { מפתח: "ערך" }));

// אוטומציה מרובת שלבים
return toResponse(responses([
  { msg: "שלב 1", shortcut: "ראשון" },
  { msg: "שלב 2", shortcut: "שני" }
]));