Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/sync-sdk-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:

- uses: actions/checkout@v4
with:
repository: LinuxDevil/agent-sdk
repository: LinuxDevil/lousho
ref: main
path: sdk

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Lousho documentation

The documentation site for [`lousho`](https://github.com/LinuxDevil/agent-sdk),
The documentation site for [`lousho`](https://github.com/LinuxDevil/lousho),
live at **[lousho.com](https://lousho.com)** in English and
[Arabic](https://lousho.com/ar/introduction). Built with [Mintlify](https://mintlify.com).

Expand Down
2 changes: 1 addition & 1 deletion acp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Agent Client Protocol (ACP)"
sidebarTitle: "Editors (ACP)"
---
{/* Generated from docs/acp.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/acp.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

The [Agent Client Protocol](https://agentclientprotocol.com) lets an editor
drive a coding agent that runs as a subprocess: the editor writes JSON-RPC 2.0
Expand Down
2 changes: 1 addition & 1 deletion agent-directories.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Agent directories"
---
{/* Generated from docs/agent-directories.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/agent-directories.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

An agent can be defined as a directory. `loadAgentDir()` reads it and calls
`createAgent()` with the options the files describe, so it returns exactly what
Expand Down
4 changes: 2 additions & 2 deletions agent-forge.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Agent Forge"
---
{/* Generated from docs/agent-forge.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/agent-forge.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

Agent Forge (`apps/agent-forge`, also called the Studio) is this SDK's
companion dashboard: one app with a left navigation to build and run agents,
Expand Down Expand Up @@ -807,7 +807,7 @@ automatically as long as `apps/agent-forge/dist-server` hasn't been built
yet:

```bash
git clone https://github.com/LinuxDevil/agent-sdk.git
git clone https://github.com/LinuxDevil/lousho.git
cd agent-sdk
npm install
npx lousho studio --dev # or just `npx lousho studio` before building
Expand Down
14 changes: 7 additions & 7 deletions agent-spec.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Agent spec v2"
sidebarTitle: "Agent spec v2"
---
{/* Generated from docs/agent-spec.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/agent-spec.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

An agent spec v2 is a YAML or JSON file that describes a whole agent as plain data: model, instructions, tools, MCP servers, skills, memory, sub-agents, handoffs, guardrails, permission rules, hooks, structured output, triggers and an optional flow. Agent Forge, the Agent Author and `lousho dev` all read and write this format.

Expand Down Expand Up @@ -381,9 +381,9 @@ Agent Forge Templates screen creates an agent from any of them.

| Template | What it does |
| -------- | ------------ |
| [`templates/support-triage`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/support-triage/spec.yaml) | Sorts each new support ticket by type and urgency and drafts a first reply for a person to send. |
| [`templates/inbox-triage`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/inbox-triage/spec.yaml) | Labels each incoming email, remembers what needs a reply, and emails you a short digest every weekday morning. |
| [`templates/incident-responder`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/incident-responder/spec.yaml) | Turns each firing alert into a short incident summary with likely causes and next steps, and posts it to Slack. |
| [`templates/pr-reviewer`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/pr-reviewer/spec.yaml) | Reviews each new or updated pull request and posts one review comment after you approve it. |
| [`templates/research-assistant`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/research-assistant/spec.yaml) | Answers a research question by reading web pages and citing every source it used. |
| [`templates/docs-qa`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/docs-qa/spec.yaml) | Answers questions about your documentation in chat or Slack and links the pages it used. |
| [`templates/support-triage`](https://github.com/LinuxDevil/lousho/blob/main/templates/support-triage/spec.yaml) | Sorts each new support ticket by type and urgency and drafts a first reply for a person to send. |
| [`templates/inbox-triage`](https://github.com/LinuxDevil/lousho/blob/main/templates/inbox-triage/spec.yaml) | Labels each incoming email, remembers what needs a reply, and emails you a short digest every weekday morning. |
| [`templates/incident-responder`](https://github.com/LinuxDevil/lousho/blob/main/templates/incident-responder/spec.yaml) | Turns each firing alert into a short incident summary with likely causes and next steps, and posts it to Slack. |
| [`templates/pr-reviewer`](https://github.com/LinuxDevil/lousho/blob/main/templates/pr-reviewer/spec.yaml) | Reviews each new or updated pull request and posts one review comment after you approve it. |
| [`templates/research-assistant`](https://github.com/LinuxDevil/lousho/blob/main/templates/research-assistant/spec.yaml) | Answers a research question by reading web pages and citing every source it used. |
| [`templates/docs-qa`](https://github.com/LinuxDevil/lousho/blob/main/templates/docs-qa/spec.yaml) | Answers questions about your documentation in chat or Slack and links the pages it used. |
2 changes: 1 addition & 1 deletion ai-sdk-ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "AI SDK UI (useChat)"
sidebarTitle: "AI SDK UI (useChat)"
---
{/* Generated from docs/ai-sdk-ui.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/ai-sdk-ui.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

If your front end already uses the Vercel AI SDK's UI hooks (`useChat` from
`@ai-sdk/react`, and the Vue, Svelte and Angular equivalents), you can keep
Expand Down
2 changes: 1 addition & 1 deletion api-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "API Overview"
sidebarTitle: "API overview"
description: "The package root (lousho) exports everything below. For the complete, generated API reference (every export, signature and doc comment), build the TypeDoc site:"
---
{/* Generated from docs/api-overview.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/api-overview.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

```bash
npm run docs:build # writes docs/api/index.html
Expand Down
2 changes: 1 addition & 1 deletion approvals.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Approvals"
---
{/* Generated from docs/approvals.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/approvals.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

Flag a tool `needsApproval` and the run pauses before calling it, until a human
(or your code) approves or rejects the call. The pause is saved in an
Expand Down
2 changes: 1 addition & 1 deletion ar/acp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Agent Client Protocol (ACP)"
sidebarTitle: "المحررات (ACP)"
---
{/* Generated from docs/acp.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/acp.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

[Agent Client Protocol](https://agentclientprotocol.com) بروتوكول يتيح للمحرر
أن يقود agent للبرمجة يعمل كعملية فرعية: المحرر يكتب طلبات JSON-RPC 2.0
Expand Down
2 changes: 1 addition & 1 deletion ar/agent-directories.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "مجلدات agent"
---
{/* Generated from docs/agent-directories.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/agent-directories.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

يمكنك تعريف الـ agent كمجلد. `loadAgentDir()` تقرأه وتستدعي `createAgent()` بالخيارات التي تصفها الملفات، فتُرجع بالضبط ما تُرجعه `createAgent()`. يبقى الـ typed code API هو المرجع الأساسي: المجلد طريقة أخرى لكتابة الخيارات نفسها، ويمكنك الانتقال إلى الكود في أي وقت دون إعادة كتابة.

Expand Down
4 changes: 2 additions & 2 deletions ar/agent-forge.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Agent Forge"
---
{/* Generated from docs/agent-forge.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/agent-forge.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

Agent Forge (`apps/agent-forge`، واسمه الآخر الـ Studio) هو الـ dashboard
المرافق لهذه الـ SDK: تطبيق واحد فيه navigation على اليسار تبني منه الـ
Expand Down Expand Up @@ -793,7 +793,7 @@ Forge ذاته، لا تستخدمه فقط — فإن `lousho studio` يعود
`apps/agent-forge/dist-server` لم يُبنَ بعد:

```bash
git clone https://github.com/LinuxDevil/agent-sdk.git
git clone https://github.com/LinuxDevil/lousho.git
cd agent-sdk
npm install
npx lousho studio --dev # or just `npx lousho studio` before building
Expand Down
14 changes: 7 additions & 7 deletions ar/agent-spec.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Agent spec v2"
sidebarTitle: "Agent spec v2"
---
{/* Generated from docs/agent-spec.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/agent-spec.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

ملف مواصفات الـ agent بالإصدار 2 (agent spec v2) هو ملف YAML أو JSON يصف agent كاملًا كبيانات عادية: الـ model، والتعليمات، والـ tools، وخوادم MCP، والـ skills، والذاكرة، والـ sub-agents، والـ handoffs، والـ guardrails، وقواعد الصلاحيات، والـ hooks، والمخرجات المنظَّمة، والـ triggers، و flow اختياري. Agent Forge والـ Agent Author و`lousho dev` كلها تقرأ هذه الصيغة وتكتبها.

Expand Down Expand Up @@ -375,9 +375,9 @@ Templates في Agent Forge تنشئ agent من أي منها.

| القالب | ما يفعله |
| -------- | ------------ |
| [`templates/support-triage`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/support-triage/spec.yaml) | يفرز كل تذكرة دعم جديدة حسب النوع والأولوية ويكتب مسودة رد أول يرسلها شخص. |
| [`templates/inbox-triage`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/inbox-triage/spec.yaml) | يصنّف كل بريد وارد، ويتذكّر ما يحتاج إلى رد، ويرسل لك ملخصًا قصيرًا كل صباح يوم عمل. |
| [`templates/incident-responder`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/incident-responder/spec.yaml) | يحوّل كل تنبيه يُطلَق إلى ملخص حادثة قصير مع الأسباب المحتملة والخطوات التالية، وينشره في Slack. |
| [`templates/pr-reviewer`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/pr-reviewer/spec.yaml) | يراجع كل pull request جديد أو محدَّث وينشر تعليق مراجعة واحدًا بعد موافقتك عليه. |
| [`templates/research-assistant`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/research-assistant/spec.yaml) | يجيب عن سؤال بحثي بقراءة صفحات الويب ويستشهد بكل مصدر استخدمه. |
| [`templates/docs-qa`](https://github.com/LinuxDevil/agent-sdk/blob/main/templates/docs-qa/spec.yaml) | يجيب عن أسئلة حول توثيقك في المحادثة أو Slack ويضع روابط الصفحات التي استخدمها. |
| [`templates/support-triage`](https://github.com/LinuxDevil/lousho/blob/main/templates/support-triage/spec.yaml) | يفرز كل تذكرة دعم جديدة حسب النوع والأولوية ويكتب مسودة رد أول يرسلها شخص. |
| [`templates/inbox-triage`](https://github.com/LinuxDevil/lousho/blob/main/templates/inbox-triage/spec.yaml) | يصنّف كل بريد وارد، ويتذكّر ما يحتاج إلى رد، ويرسل لك ملخصًا قصيرًا كل صباح يوم عمل. |
| [`templates/incident-responder`](https://github.com/LinuxDevil/lousho/blob/main/templates/incident-responder/spec.yaml) | يحوّل كل تنبيه يُطلَق إلى ملخص حادثة قصير مع الأسباب المحتملة والخطوات التالية، وينشره في Slack. |
| [`templates/pr-reviewer`](https://github.com/LinuxDevil/lousho/blob/main/templates/pr-reviewer/spec.yaml) | يراجع كل pull request جديد أو محدَّث وينشر تعليق مراجعة واحدًا بعد موافقتك عليه. |
| [`templates/research-assistant`](https://github.com/LinuxDevil/lousho/blob/main/templates/research-assistant/spec.yaml) | يجيب عن سؤال بحثي بقراءة صفحات الويب ويستشهد بكل مصدر استخدمه. |
| [`templates/docs-qa`](https://github.com/LinuxDevil/lousho/blob/main/templates/docs-qa/spec.yaml) | يجيب عن أسئلة حول توثيقك في المحادثة أو Slack ويضع روابط الصفحات التي استخدمها. |
2 changes: 1 addition & 1 deletion ar/ai-sdk-ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "AI SDK UI (useChat)"
sidebarTitle: "AI SDK UI (useChat)"
---
{/* Generated from docs/ai-sdk-ui.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/ai-sdk-ui.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

إذا كانت الواجهة الأمامية (front end) لديك تستخدم أصلًا الـ UI hooks في Vercel AI SDK (`useChat` من `@ai-sdk/react` ومثيلاتها في Vue وSvelte وAngular)، فيمكنك إبقاؤها على حالها وتشغيل Lousho agent خلف الـ route. ثلاث دوال مُصدَّرة من جذر الحزمة تتولى التحويل. لا تستورد شيئًا من `ai`، ولا تستخدم أي `node:*` module، وتعمل على Node وWorkers وأي runtime مبني على Fetch.

Expand Down
2 changes: 1 addition & 1 deletion ar/api-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "نظرة عامة على الـ API"
sidebarTitle: "نظرة عامة على الـ API"
description: "جذر الحزمة (lousho) يصدّر كل شيء أدناه. للمرجع الكامل المولّد للـ API (كل export وكل signature وكل تعليق توثيقي)، ابنِ موقع TypeDoc:"
---
{/* Generated from docs/api-overview.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/api-overview.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

```bash
npm run docs:build # writes docs/api/index.html
Expand Down
2 changes: 1 addition & 1 deletion ar/approvals.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Approvals"
---
{/* Generated from docs/approvals.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/approvals.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

علّم الـ tool بـ `needsApproval` فيتوقف الـ run قبل تنفيذ الاستدعاء،
حتى يوافق إنسان (أو الكود الخاص بك) على الـ call أو يرفضه. التوقف محفوظ
Expand Down
2 changes: 1 addition & 1 deletion ar/auth.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Route auth والـ principals"
---
{/* Generated from docs/auth.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/auth.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

أي agent يعمل عبر HTTP يحتاج إلى معرفة أمرين عن كل request: هل يُسمح له بالمرور أصلًا، ومن المتصل. تجيب `lousho/auth` عن السؤالين. أنت تعطي الـ route قائمة مرتبة من مدخلات auth: `jwt()` أو `oidc()` أو `basic()` أو `apiToken()` أو `anonymous()`، أو function تكتبها بنفسك. أول entry يقبل الـ request يُرجع **principal** (هوية المتصل بعد أن تحققت منها auth)، وهذا الـ principal يدخل الـ run، وهناك تستطيع دوال `model` و`instructions` و`tools` ونطاقات الـ memory قراءته.

Expand Down
2 changes: 1 addition & 1 deletion ar/build-a-coding-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "ابنِ coding agent"
sidebarTitle: "ابنِ coding agent"
---
{/* Generated from docs/build-a-coding-agent.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/build-a-coding-agent.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

هذه الصفحة تبني coding agent يعمل في الـ terminal على طريقة Claude Code: يقرأ ملفات مشروعك ويعدّلها، ويشغّل أوامر، ويسألك قبل أن يكتب ملفًا أو يشغّل شيئًا خطرًا، ويُبقي المحادثة مستمرة لأسئلة المتابعة. تحتاج إلى Node 22، ومفتاح API في متغيّر البيئة الذي يتوقعه الـ provider (`OPENAI_API_KEY` للـ model المستخدم هنا)، ومجلد مشروع تشغّله فيه. الملف الجاهز في آخر [الخطوة 5](#5-حافظ-على-استمرار-المحادثة)، وتشغّله هكذا `npx tsx coding.ts "Fix the failing test"`.

Expand Down
2 changes: 1 addition & 1 deletion ar/channels.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Channels"
---
{/* Generated from docs/channels.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/channels.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

يربط الـ **channel** الـ agent بطرف واحد: JSON API، أو webhook، أو تطبيق
محادثة. وهو الذي يحدد طريقة مصادقة الطلب الوارد، والمحادثة التي ينتمي إليها، وكيف
Expand Down
2 changes: 1 addition & 1 deletion ar/claude-projects.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "مشاريع Claude Code"
---
{/* Generated from docs/claude-projects.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/claude-projects.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

المستودع الذي يحمل أصلًا ملفات Claude Code المعتادة —
`CLAUDE.md` و`.claude/skills/` و`.claude/agents/` و`.claude/rules/`
Expand Down
2 changes: 1 addition & 1 deletion ar/cli.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CLI"
---
{/* Generated from docs/cli.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/cli.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

تثبيت الحزمة يثبّت معها أمر `lousho`. ينشئ مشاريع جديدة، ويفحص الإعداد الخاص بك، ويشغّل agent محليًا، ويقدّمه عبر MCP، ويشغّل evals، ويعرض traces محفوظة، ويبني artifact جاهزًا للنشر، ويفتح لوحة Agent Forge. شغّله بـ `npx lousho <command>` داخل مشروع مثبّت فيه الـ SDK.

Expand Down
2 changes: 1 addition & 1 deletion ar/cloudflare-workers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Cloudflare Workers"
---

{/* Generated from docs/cloudflare-workers.md in LinuxDevil/agent-sdk by scripts/sync-sdk-docs.mjs. Do not edit here. */}
{/* Generated from docs/cloudflare-workers.md in LinuxDevil/lousho by scripts/sync-sdk-docs.mjs. Do not edit here. */}

الأمر `npx lousho build --target=cloudflare-worker --agent=agent.yaml` يولّد module Worker باسم `worker.ts`، و`wrangler.toml`، وbundle هو `dist/worker.js` يفحصه الـ build بحثًا عن استيرادات `node:`. يحتاج `tsup` و`wrangler` مثبتين، ويأخذ [ملف agent spec](/ar/configuration) أو [agent directory](/ar/agent-directories) (`npx lousho build ./my-agent --target=cloudflare-worker`). الـ Worker يقدّم نفس [HTTP API](/ar/deployment#http-api) التي تقدّمها الأهداف الثانية. هذا الهدف هو الأضيق حدودًا بين الثلاثة، فنبدأ بحدوده.

Expand Down
Loading
Loading