CLI pdfx: Satu Katalog, Dipanggil dari Terminal Anda
CLI pdfx menghantar permintaan multipart yang sama seperti curl ke API PDF123 atau pdfx-server anda sendiri, sambil menambah larian kelompok, kata laluan setiap fail dan kod keluar yang boleh dipakai skrip untuk bercabang.

PDF123 ialah nama produk. pdfx ialah katalog operasi yang sama yang dibalut untuk shell: ia membina permintaan multipart yang akan dibina curl, menghantarnya ke asas API yang anda pilih, dan menulis hasilnya di sebelah fail anda. Gabungkan, Mampatkan, OCR dan selebihnya dalam katalog boleh dipanggil dengan cara ini.
Apa yang sebenarnya dihantar oleh satu panggilan
pdfx --api-base "$API_BASE" --api-key "$PDFX_API_KEY" \
merge a.pdf b.pdf -o merged.pdf
--api-base lalai kepada https://pdf123.xyz, dan --api-key (atau pemboleh ubah persekitaran PDFX_API_KEY) adalah pilihan, jadi katalog tanpa nama berfungsi tanpanya. Halakan asas ke http://127.0.0.1:8080 untuk tindanan docker-compose anda sendiri. Tiada protokol kedua di bawahnya: CLI ialah klien bagi permukaan REST yang didokumenkan di Pembangun, dan nama opnya sejajar dengan alat portal serta dokumen OpenAPI di /v1/openapi.json.
Katalog boleh ditemui tanpa meninggalkan terminal. pdfx list mencetak setiap alat dan pdfx describe add-stamp mencetak medan serta nilai lalai satu alat, iaitu definisi yang sama yang dipaparkan portal sebagai borang.
Larian kelompok dan bendera yang curl memaksa anda tulis sendiri
Berikan beberapa input kepada alat satu fail dan ia menjalankannya sebagai kelompok ke dalam direktori -o, mencetak satu baris input -> saved bagi setiap fail. Kegagalan pergi ke stderr dan fail selebihnya tetap selesai, jadi satu PDF rosak dalam folder invois tidak membatalkan keseluruhan larian. --concurrency <n> menetapkan berapa banyak fail diproses serentak (lalai 2).
-o menerima fail atau direktori dan tidak pernah menimpa fail yang sedia ada, sebaliknya menggunakan nama fail daripada pelayan di dalam direktori itu. Ini penting apabila pelayan menamakan hasil mengikut input: tanpanya, satu larian akan menimpa PDF yang baru anda muat naik.
Input yang disulitkan dibuka sebelum permintaan, bukan oleh alat: --input-password meliputi setiap fail dalam larian itu, dan --password-for report.pdf=secret menetapkan kata laluan satu fail dan boleh diulang, dengan * mewakili selebihnya. Kelompok yang mencampurkan fail terkunci dan terbuka tidak perlu diasingkan secara manual. --json mencetak { path, contentType, bytes } bagi setiap hasil, atau [{ input, ok, path | error, reason }] untuk kelompok, supaya pembalut boleh menghurai hasilnya dan bukan mengikis baris yang dibaca manusia.
Kod keluar yang boleh dicabang oleh skrip
0 bermaksud berjaya, 1 bermaksud satu permintaan gagal (dalam kelompok: sekurang-kurangnya satu fail), 2 ialah ralat penggunaan yang tidak memuat naik apa-apa, dan 130 bermaksud anda menghentikannya dan permintaan yang sedang berjalan dibatalkan. Kegagalan mencetak baris reason:, code: dan hint: di bawah mesej apabila tersedia, dan inilah yang perlu dipadankan oleh skrip, bukan prosa.
Satu kod keluar mudah disalah baca. Alat yang tidak menemui apa-apa untuk dipulangkan keluar dengan bukan sifar bersama code: no_content dan bukan menulis fail kosong, jadi pdf-to-csv pada PDF tanpa jadual ialah kegagalan, bukan CSV sifar bait.
Ke mana bait pergi
Fail dimuat naik ke asas API, diproses di sana, dan dipadam sebaik respons dihantar. Itu kontrak yang sama seperti borang pelayar; CLI menukar klien, bukan destinasi. Untuk dokumen yang tidak boleh meninggalkan rangkaian anda, jalankan pdfx-server sendiri dan halakan --api-base kepadanya, seperti yang dibincangkan di Self-host.
Tiada mod luar talian untuk dijadikan sandaran: jika asas tidak dapat dicapai, perintah itu gagal. pdfx ialah klien rangkaian yang kebetulan selesa dalam shell, bukan enjin PDF setempat.
Apa yang bukan CLI ini
pdfx bukan GUI desktop dan bukan pustaka OCR boleh benam yang anda pautkan ke dalam aplikasi lain. Ia klien baris perintah untuk operasi PDF, jadi kerja sekali oleh manusia masih lebih baik melalui portal (Mampatkan, OCR dan selebihnya dalam katalog), dan apa-apa yang memerlukan pokok UI sendiri akan mencipta semula masalah hanyut yang diterangkan dalam Operasi sama, empat klien.
Ejen mendapat bentuk yang sama daripada skill terbitan di /skills/pdf123.md, yang mendokumenkan permintaan merge dan pipeline sepenuhnya. Untuk cubaan semula POST yang mengubah keadaan dengan selamat, hantar Idempotency-Key; CLI masih membuat satu permintaan bagi setiap seruan, jadi pengepala itu terletak pada apa sahaja yang mencuba semula (Idempotency-Key: Cubaan Semula Selamat untuk Tugasan PDF). Kunci, had kadar dan kod ralat ada di Pembangun.