PPDF123
Product3 menit baca

CLI pdfx: satu katalog, dipanggil dari terminal Anda

CLI pdfx mengirim permintaan multipart yang sama seperti curl ke API PDF123 atau pdfx-server Anda sendiri, lalu menambahkan eksekusi batch, kata sandi per berkas, dan kode keluar yang bisa dicabang oleh skrip.

By the PDF123 team Β· Updated 2026-09-29
CLI pdfx: satu katalog, dipanggil dari terminal Anda

PDF123 adalah nama produknya. pdfx adalah katalog operasi yang sama, dibungkus untuk shell: ia menyusun permintaan multipart yang akan disusun curl, mengirimkannya ke base API pilihan Anda, dan menulis hasilnya di samping berkas Anda. Merge, Compress, OCR, dan sisa katalog bisa dipanggil dengan cara ini.

Apa yang sebenarnya dikirim sebuah panggilan

pdfx --api-base "$API_BASE" --api-key "$PDFX_API_KEY" \
  merge a.pdf b.pdf -o merged.pdf

--api-base bernilai https://pdf123.xyz secara default, dan --api-key (atau variabel lingkungan PDFX_API_KEY) bersifat opsional, sehingga katalog anonim berjalan tanpa itu. Arahkan base ke http://127.0.0.1:8080 untuk tumpukan docker-compose milik Anda. Tidak ada protokol kedua di bawahnya: CLI adalah klien bagi permukaan REST yang didokumentasikan di Developers, dan nama operasinya selaras dengan alat portal serta dokumen OpenAPI di /v1/openapi.json.

Katalog bisa dijelajahi tanpa meninggalkan terminal. pdfx list mencetak setiap alat dan pdfx describe add-stamp mencetak field serta nilai default satu alat, yaitu definisi yang sama dengan yang dirender portal sebagai formulir.

Eksekusi batch dan flag yang curl memaksa Anda tulis sendiri

Beri sebuah alat satu-berkas beberapa input dan ia menjalankannya sebagai batch ke direktori -o, mencetak satu baris input -> saved per berkas. Kegagalan masuk ke stderr dan berkas sisanya tetap selesai, sehingga satu PDF rusak di folder faktur tidak membatalkan seluruh eksekusi. --concurrency <n> menentukan berapa berkas yang diproses sekaligus (default 2).

-o menerima berkas atau direktori dan tidak pernah menimpa berkas yang sudah ada; di dalam direktori ia memakai nama berkas dari server. Itu penting ketika server menamai hasil berdasarkan input: tanpa itu, satu eksekusi akan menimpa PDF yang baru saja Anda unggah.

Input terenkripsi dibuka sebelum permintaan, bukan oleh alatnya: --input-password mencakup setiap berkas dalam eksekusi, dan --password-for report.pdf=secret menetapkan kata sandi satu berkas dan bisa diulang, dengan * mewakili sisanya. Batch yang mencampur berkas terkunci dan terbuka tidak perlu diurutkan manual. --json mencetak { path, contentType, bytes } per hasil, atau [{ input, ok, path | error, reason }] untuk batch, sehingga pembungkus bisa mengurai hasilnya alih-alih mengikis baris yang terbaca manusia.

Kode keluar yang bisa dicabang skrip

0 berarti sukses, 1 berarti ada permintaan yang gagal (dalam batch: setidaknya satu berkas), 2 adalah kesalahan pemakaian yang tidak mengunggah apa pun, dan 130 berarti Anda menghentikannya dan permintaan yang sedang berjalan dibatalkan. Kegagalan mencetak baris reason:, code:, dan hint: di bawah pesan ketika tersedia, dan itulah yang sebaiknya dicocokkan skrip, bukan prosanya.

Satu status keluar mudah salah dibaca. Alat yang tidak menemukan apa pun untuk dikembalikan keluar dengan status bukan nol dan code: no_content, bukan menulis berkas kosong, sehingga pdf-to-csv pada PDF tanpa tabel adalah kegagalan, bukan CSV nol byte.

Ke mana byte pergi

Berkas diunggah ke base API, diproses di sana, lalu dihapus begitu respons terkirim. Kontraknya sama dengan formulir browser; CLI mengubah kliennya, bukan tujuannya. Untuk dokumen yang tidak boleh keluar dari jaringan Anda, jalankan pdfx-server sendiri dan arahkan --api-base ke sana, yang dibahas di Self-host.

Tidak ada mode offline sebagai cadangan: bila base tidak terjangkau, perintahnya gagal. pdfx adalah klien jaringan yang kebetulan nyaman di shell, bukan mesin PDF lokal.

Apa yang bukan CLI ini

pdfx bukan GUI desktop dan bukan pustaka OCR yang bisa Anda tautkan ke aplikasi lain. Ia klien baris perintah untuk operasi PDF, jadi pekerjaan manusia sekali pakai tetap lebih baik dilayani portal (Compress, OCR, dan sisa katalog), dan apa pun yang menuntut pohon antarmuka sendiri akan menciptakan ulang masalah penyimpangan yang diuraikan di Operasi yang sama, empat klien.

Agen memperoleh bentuk yang sama dari skill yang diterbitkan di /skills/pdf123.md, yang mendokumentasikan permintaan merge dan pipeline secara lengkap. Untuk percobaan ulang POST yang mengubah data secara aman, kirim Idempotency-Key; CLI tetap membuat satu permintaan per pemanggilan, jadi header itu berada pada apa pun yang mengulanginya (Idempotency-Key: percobaan ulang yang aman untuk tugas PDF). Key, batas laju, dan kode galat ada di Developers.

Open tool
Process in the browser β€” no watermark, files removed after the job.
Open tool