pdfx CLI: एक ही कैटलॉग, अपने टर्मिनल से
pdfx CLI वही मल्टीपार्ट अनुरोध curl की तरह PDF123 API या आपके अपने pdfx-server को भेजता है, और बैच रन, प्रति-फ़ाइल पासवर्ड तथा स्क्रिप्ट के लिए शाखा-योग्य exit कोड जोड़ता है।

PDF123 उत्पाद का नाम है। pdfx वही प्रचालन-कैटलॉग है जो shell के लिए लपेटा गया है: यह वही मल्टीपार्ट अनुरोध बनाता है जो curl बनाता, उसे आपके चुने API बेस पर भेजता है, और नतीजा आपकी फ़ाइलों के पास लिखता है। Merge, Compress, OCR और बाक़ी कैटलॉग इसी तरह बुलाए जा सकते हैं।
एक कॉल असल में क्या भेजती है
pdfx --api-base "$API_BASE" --api-key "$PDFX_API_KEY" \
merge a.pdf b.pdf -o merged.pdf
--api-base बिना दिए डिफ़ॉल्ट https://pdf123.xyz रहता है, और --api-key (या PDFX_API_KEY पर्यावरण चर) वैकल्पिक है, इसलिए अनाम कैटलॉग इसके बिना भी चलता है। अपने docker-compose स्टैक के लिए बेस को http://127.0.0.1:8080 पर इंगित करें। नीचे कोई दूसरा प्रोटोकॉल नहीं है: CLI, Developers पर दर्ज REST सतह का क्लाइंट है, और उसके प्रचालन-नाम पोर्टल टूल तथा /v1/openapi.json के OpenAPI दस्तावेज़ से मेल खाते हैं।
कैटलॉग टर्मिनल छोड़े बिना खोजा जा सकता है। pdfx list हर टूल छापता है और pdfx describe add-stamp किसी टूल के फ़ील्ड और डिफ़ॉल्ट छापता है, जो वही परिभाषा है जिसे पोर्टल फ़ॉर्म के रूप में रेंडर करता है।
बैच रन और वे फ़्लैग जो curl आपसे ख़ुद लिखवाता है
किसी एकल-फ़ाइल टूल को कई इनपुट दें और वह उन्हें -o निर्देशिका में बैच की तरह चलाता है, हर फ़ाइल के लिए एक input -> saved पंक्ति छापते हुए। विफलताएँ stderr पर जाती हैं और बाक़ी फ़ाइलें फिर भी पूरी होती हैं, इसलिए इनवॉइस की निर्देशिका में एक ख़राब PDF पूरा रन नहीं रोकता। --concurrency <n> तय करता है कि एक साथ कितनी फ़ाइलें प्रक्रिया में रहें (डिफ़ॉल्ट 2)।
-o एक फ़ाइल या निर्देशिका लेता है और मौजूदा फ़ाइल को कभी नहीं मिटाता; निर्देशिका के भीतर वह सर्वर का दिया नाम इस्तेमाल करता है। यह तब मायने रखता है जब सर्वर नतीजे का नाम इनपुट से लेता है: इसके बिना, एक रन उसी PDF को मिटा देती जिसे आपने अभी अपलोड किया।
एन्क्रिप्टेड इनपुट अनुरोध से पहले खोले जाते हैं, टूल द्वारा नहीं: --input-password रन की हर फ़ाइल पर लागू होता है, और --password-for report.pdf=secret एक फ़ाइल का पासवर्ड तय करता है और दोहराया जा सकता है, बाक़ी के लिए * खड़ा होता है। इस तरह बंद और खुली फ़ाइलों का मिश्रित बैच बिना हाथ से छाँटे चलता है। --json हर नतीजे के लिए { path, contentType, bytes } छापता है, या बैच के लिए [{ input, ok, path | error, reason }], ताकि आवरण मानव-पठनीय पंक्तियाँ स्क्रैप करने के बजाय नतीजा पार्स कर सके।
वे exit कोड जिन पर स्क्रिप्ट शाखा बना सके
0 सफलता है, 1 का अर्थ है कोई अनुरोध फेल हुआ (बैच में: कम से कम एक फ़ाइल), 2 उपयोग-त्रुटि है जहाँ कुछ भी अपलोड नहीं हुआ, और 130 का अर्थ है कि आपने रोका और प्रक्रिया में मौजूद अनुरोध निरस्त हुआ। विफलताएँ संदेश के नीचे reason:, code: और hint: पंक्तियाँ छापती हैं जब वे उपलब्ध हों, और स्क्रिप्ट को गद्य नहीं, इन्हीं से मिलान करना चाहिए।
एक exit कोड भूल से पढ़ा जा सकता है। जिस टूल के पास लौटाने को कुछ न हो, वह खाली फ़ाइल लिखने के बजाय ग़ैर-शून्य स्थिति और code: no_content के साथ बाहर निकलता है, इसलिए बिना तालिकाओं वाली PDF पर pdf-to-csv विफलता है, शून्य-बाइट CSV नहीं।
बाइट्स कहाँ जाते हैं
फ़ाइलें API बेस पर अपलोड होती हैं, वहीं प्रोसेस होती हैं, और प्रतिक्रिया भेजे जाते ही हटा दी जाती हैं। यह वही अनुबंध है जो ब्राउज़र फ़ॉर्म का है; CLI गंतव्य नहीं, क्लाइंट बदलता है। जो दस्तावेज़ आपके नेटवर्क से बाहर नहीं जाने चाहिए, उनके लिए ख़ुद pdfx-server चलाएँ और --api-base उस पर इंगित करें, जिसे Self-host में समझाया गया है।
लौटने के लिए कोई ऑफ़लाइन मोड नहीं है: बेस तक न पहुँचे तो कमांड फेल हो जाता है। pdfx एक नेटवर्क क्लाइंट है जो shell में सुविधाजनक लगता है, स्थानीय PDF इंजन नहीं।
CLI जो नहीं है
pdfx न डेस्कटॉप GUI है, न कोई ऐसी एम्बेड करने योग्य OCR लाइब्रेरी जिसे आप दूसरे ऐप में जोड़ें। यह PDF प्रचालनों के लिए कमांड-लाइन क्लाइंट है, इसलिए एक-बारगी मानवीय काम अब भी पोर्टल से बेहतर होता है (Compress, OCR और बाक़ी कैटलॉग), और जिसे अपना अलग इंटरफ़ेस वृक्ष चाहिए वह वही प्रचालन, चार क्लाइंट में बताई ड्रिफ़्ट समस्या दोहरा देगा।
एजेंट को वही आकृतियाँ /skills/pdf123.md पर प्रकाशित स्किल से मिलती हैं, जो मर्ज और पाइपलाइन अनुरोध पूरे दर्ज करती है। बदलाव करने वाले POST के सुरक्षित पुनः प्रयासों के लिए Idempotency-Key भेजें; CLI हर बुलावे पर अब भी एक अनुरोध करता है, इसलिए यह शीर्षलेख उसी में जाता है जो उसे दोहराता है (Idempotency-Key: PDF कार्यों के सुरक्षित पुनः प्रयास)। चाबियाँ, दर-सीमाएँ और त्रुटि कोड Developers पर हैं।