Skip to content

Installation

KSeF2 CLI requires Python 3.12 or newer.

For local development from a checkout, use uv:

Terminal window
uv sync
uv run ksef2 --help

For an installed package, use either executable:

Terminal window
ksef2 --help
ksef2-cli --help

Both entry points run the same Typer application.

The top-level command lists global options first and command groups second:

Terminal window
uv run ksef2 --help

Use group help to inspect a specific workflow:

Terminal window
uv run ksef2 invoices --help
uv run ksef2 online --help
uv run ksef2 batch --help

Use --json when you need machine-readable output:

Terminal window
uv run ksef2 --json config path

The default environment is production. Pass --env before the command group when you need test or demo:

Terminal window
uv run ksef2 --env test --help

Supported values are:

  • production
  • demo
  • test