Product3 min läsning

pdfx CLI: en katalog, anropad från din terminal

pdfx CLI skickar samma multipart-anrop som curl till PDF123:s API eller din egen pdfx-server, och lägger till batchkörningar, lösenord per fil och utgångskoder som ett skript kan förgrena sig på.

By the PDF123 team · Updated 2026-09-29
pdfx CLI: en katalog, anropad från din terminal

PDF123 är produktnamnet. pdfx är samma operationskatalog paketerad för ett skal: den bygger den multipart-begäran som curl hade byggt, skickar den till den basadress du väljer och skriver resultatet bredvid dina filer. Slå ihop PDF, Komprimera PDF, OCR och resten av katalogen går att anropa så här.

Vad ett anrop faktiskt skickar

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

--api-base har standardvärdet https://pdf123.xyz, och --api-key (eller miljövariabeln PDFX_API_KEY) är valfri, så den anonyma katalogen fungerar utan nyckel. Peka basen mot http://127.0.0.1:8080 för en egen docker-compose-stack. Det finns inget andra protokoll under: kommandoradsverktyget är en klient mot REST-ytan som beskrivs på Utvecklare, och operationsnamnen följer portalens verktyg och OpenAPI-dokumentet på /v1/openapi.json.

Katalogen går att utforska utan att lämna terminalen. pdfx list skriver ut varje verktyg och pdfx describe add-stamp skriver ut ett verktygs fält och standardvärden, samma definition som portalen renderar som ett formulär.

Batchkörningar och flaggorna curl tvingar dig skriva själv

Ge ett verktyg för enskilda filer flera indata och det kör dem som en batch i katalogen för -o och skriver en rad input -> saved per fil. Fel går till stderr och de återstående filerna blir ändå klara, så en dålig PDF i en mapp med fakturor avbryter inte körningen. --concurrency <n> anger hur många filer som är igång samtidigt (standard 2).

-o tar en fil eller en katalog och skriver aldrig över en befintlig fil, utan använder serverns filnamn inuti katalogen i stället. Det spelar roll när servern namnger resultatet efter indata: utan regeln skulle en körning skriva över PDF-filen du just laddade upp.

Krypterade indata öppnas före begäran, inte av verktyget: --input-password täcker varje fil i körningen, och --password-for report.pdf=secret sätter en fils lösenord och kan upprepas, där * står för resten. En batch som blandar låsta och öppna filer behöver alltså ingen manuell sortering. --json skriver { path, contentType, bytes } per resultat, eller [{ input, ok, path | error, reason }] för en batch, så en omslutning kan tolka utfallet i stället för att skrapa de läsbara raderna.

Utgångskoder ett skript kan förgrena sig på

0 betyder framgång, 1 att en begäran misslyckades (i en batch: minst en fil), 2 är ett användningsfel där inget laddades upp, och 130 betyder att du avbröt och den pågående begäran avbröts. Fel skriver ut raderna reason:, code: och hint: under meddelandet när de finns, och det är dem ett skript bör matcha i stället för prosa.

En utgång är lätt att feltolka. Ett verktyg som inte hittar något att returnera avslutas med en kod som inte är noll och code: no_content i stället för att skriva en tom fil, så pdf-to-csv på en PDF utan tabeller är ett misslyckande, inte en CSV på noll byte.

Vart byten tar vägen

Filerna laddas upp till basadressen, bearbetas där och raderas när svaret har skickats. Det är samma kontrakt som formuläret i webbläsaren: kommandoradsverktyget byter klient, inte destination. För dokument som inte får lämna ditt nätverk kan du köra en pdfx-server själv och peka --api-base mot den, vilket beskrivs under Kör själv.

Det finns inget offlineläge att falla tillbaka på: om basen inte går att nå misslyckas kommandot. pdfx är en nätverksklient som råkade bli trevlig i ett skal, inte en lokal PDF-motor.

Vad kommandoradsverktyget inte är

pdfx är varken ett grafiskt skrivbordsprogram eller ett inbäddningsbart OCR-bibliotek som du länkar in i en annan app. Det är en kommandoradsbaserad klient för PDF-operationer, så ett enstaka manuellt jobb betjänas fortfarande bättre av portalen (Komprimera PDF, OCR och resten av katalogen), och allt som behöver en egen UI-struktur skulle återskapa divergensproblemet som beskrivs i Samma operation, fyra klienter.

Agenter får samma former från den publicerade skillen på /skills/pdf123.md, som beskriver merge- och pipeline-begärandena i sin helhet. För säkra återförsök av ändrande POST skickar du Idempotency-Key; kommandoradsverktyget gör fortfarande en begäran per anrop, så huvudet hör hemma i det som gör om den (Idempotency-Key: säkra återförsök för PDF-jobb). Nycklar, hastighetsgränser och felkoder finns på Utvecklare.

Open tool
Process in the browser — no watermark, files removed after the job.
Open tool