السكربتات

مع --json لا يحتوي stdout إلا على JSON بإزاحة مسافتين، بينما تبقى الملاحظات والتقدم على stderr، ولا يُطرح أي سؤال. تطبع القائمة { items, hasMore, nextCursor }، ويُطبع كائن API كما أعادته API، ويطبع الأمر المكتوب يدويًا الكائن الذي تصفه مساعدته.

openemail whoami --json | jq -r .workspaceIdopenemail emails list --status failed --json | jq -r ".items[].id"

يذهب الخطأ إلى stderr كسطر JSON واحد، ورمز الخروج هو نفسه الذي كان سيحصل عليه الشخص:

{"error":{"type":"permission_error","code":"insufficient_scope","message":"This API key does not have the domains:write scope.","hint":"The credential is missing a scope this call needs. Use a key that has it, or sign in again with openemail login.","next":null,"status":403,"requestId":"req_7Hc2kQ","param":null,"docUrl":"https://openemail.uk/docs/api/errors#insufficient_scope","exitCode":4}}

بعض المخرجات تدفق من كائنات JSON، واحد في كل سطر، كي يعالج خط المعالجة كل عنصر فور وصوله:

• —قائمة موارد مع --all حين لا يكون stdout طرفية، أو مع --ndjson. ويتوقف --max <n> بعد هذا العدد من العناصر.
• —openemail temp watch --json، سطر واحد لكل رسالة جديدة.
• —openemail mcp serve، رسالة JSON-RPC واحدة في كل سطر في كل اتجاه.

openemail contacts list --all > contacts.ndjsonopenemail emails list --status failed --all --max 500 | jq -r .id

لا تطرح CLI أسئلة إلا حين يكون stdin وstdout كلاهما طرفية، ولا ينطبق أي من --json أو --no-input أو CI. وإلا:

• —القيمة المطلوبة الناقصة تتوقف برمز الخروج 2 وتسمّي الخيار الذي يجب تمريره.
• —الأمر المدمّر يتوقف بالرسالة Refusing to run unattended. Pass --yes to confirm. ورمز الخروج 2، ما لم تمرّر --yes.
• —التغيير الذي يحتاج إلى رمز تحقق يتوقف برمز الخروج 4، لأن لا أحد يستطيع كتابته. استخدم مفتاح API، أو شغّل openemail verify أولًا.

امنح المهمة مفتاح API بالنطاقات التي تحتاجها فقط، واحفظه في سرّ، ودع OPENEMAIL_API_KEY يحمله. لا يُحفظ شيء، ولا يُطرح أي سؤال، ولا يجري أي تحقق من التحديثات.

- name: Tell the team  env:    OPENEMAIL_API_KEY: ${{ secrets.OPENEMAIL_API_KEY }}  run: |    npx -y @openemail/[email protected] send \      --from [email protected] \      --to [email protected] \      --subject "Deployed ${{ github.sha }}" \      --text "Build ${{ github.run_number }} is live." \      --idempotency-key "deploy-${{ github.run_id }}"

ADDRESS=$(npx -y @openemail/[email protected] temp new --ttl 15)./signup-test.sh "$ADDRESS"npx -y @openemail/[email protected] temp watch --first --json | jq -r .snippetnpx -y @openemail/[email protected] temp delete --yes

failed=$(openemail emails list --status failed --json | jq ".items | length")test "$failed" -eq 0