node-zugferd
IntroductionInstallation
CLIOptionsContributingAPI Reference

CLI

Parse

Terminal
npx @node-zugferd/cli@beta parse

Options

  • --cwd - The current working directory.
  • --profile - The profile to use for parsing the invoice.
  • --input - The invoice file to parse.
  • --output - The output file to write the JSON to.
  • --minify - Minify the output.

Init

Terminal
npx @node-zugferd/cli@beta init

Options

  • --cwd - The current working directory.
  • --config - The path to the zugferd configuration file. Defaults to the first invoicer.ts or zugferd.ts file found.
  • --package-manager - The package manager to use.

Upgrade

The upgrade commands upgrades older node-zugferd dependencies and @node-zugferd/* packages that participate in the synchronized release train to the version of the CLI being run. It compares the minimum version allowed by each package.json specifier; specifiers whose minimum is the same or newer are left unchanged.

Terminal
npx @node-zugferd/cli@beta upgrade

Options

  • --cwd - The project directory containing the package.json to update. Defaults to the current working directory.
  • --yes - Skip the confirmation prompt and install updates directly.

Info

The info command provides diagnostic information about your node-zugferd setup and environment. Useful for debugging and sharing when seeking support.

Terminal
npx @node-zugferd/cli@beta info

Output

The command displays:

  • System: OS, CPI, memory, Node.js version
  • Package Manager: Detected manager and version
  • Frameworks: Detected frameworks (Next.js, Hono, Cloudflare, etc.)
  • node-zugferd: Version and configuration

Options

  • --cwd - The current working directory.
  • --config - The path to your node-zugferd configuration file.
  • --json - Output as JSON for sharing or programmatic use.
  • --copy - Copy output to clipboard. (requires pbcopy/xclip)

 

llms.txt
LLMs.txt

Options

node-zugferd configuration options reference.

Edit on GitHubPrivacyImprint

On this page

ParseOptionsInitOptionsUpgradeOptionsInfoOutputOptions

How is this guide?