Dokumentacja

Przewodnik po aplikacji KSeFka

CLI — interfejs wiersza poleceń#

KSeFka dostarcza CLI (ksefka) do zarządzania fakturami, kontrahentami i danymi bezpośrednio z terminala lub skryptów.

Instalacja#

CLI jest dołączone do instalatora KSeFka i dostępne jako ksefka w terminalu po zainstalowaniu aplikacji. Na Windows instalator automatycznie dodaje katalog instalacji do zmiennej PATH.

Weryfikacja instalacji:

ksefka --version

Opcje globalne#

OpcjaOpis
--env <środowisko>Środowisko KSeF: test, demo, production (domyślnie: production)
--company <nip>NIP firmy, gdy masz skonfigurowanych kilka firm
--helpWyświetl pomoc dla komendy

Jak znaleźć pomoc#

Każda komenda ma wbudowaną dokumentację:

ksefka --help                    # lista wszystkich komend
ksefka <komenda> --help          # szczegóły konkretnej komendy

Komendy#

KomendaOpis
Faktury
list-invoicesLista faktur z filtrowaniem
get-invoiceSzczegóły faktury z pozycjami
create-invoiceUtwórz fakturę z pliku JSON lub stdin
finalizePrzenieś fakturę roboczą do stanu „gotowa do wysłania"
unfinalizeCofnij finalizację faktury do wersji roboczej
copy-invoiceSkopiuj fakturę jako nowy szkic z dzisiejszą datą
openOtwórz fakturę w aplikacji desktopowej
Kontrahenci
list-contractorsLista kontrahentów z wyszukiwaniem
get-contractorSzczegóły kontrahenta
create-contractorDodaj kontrahenta z pliku JSON lub stdin
update-contractorZaktualizuj dane kontrahenta
delete-contractorUsuń (dezaktywuj) kontrahenta
Produkty
list-productsLista produktów/usług z katalogu
get-productSzczegóły produktu
create-productDodaj produkt do katalogu
Raporty
monthly-summaryPodsumowanie miesięczne (przychody/koszty)
dashboard-statsStatystyki bieżącego miesiąca
Inne
mcpUruchom serwer MCP (stdio)

Wejście JSON#

Komendy tworzące obiekty (np. create-invoice, create-contractor) przyjmują dane jako:

# z pliku
ksefka create-invoice --file faktura.json

# ze stdin (pipe)
cat faktura.json | ksefka create-invoice --file -

# lub przekierowanie
ksefka create-invoice --file - < faktura.json

Strukturę JSON znajdziesz w pomocy komendy: ksefka create-invoice --help.