Documentation
From first invoice
to your own setup.
Learn the web app, work in your terminal, connect to the API, and understand every check. Find step-by-step guides and commands you can copy.
Start here
Inspect your first invoice
Paste a payment request or try a sample. Read the summary, explore validation, and export the result.
Explore the guides
Use the web decoder
Paste an invoice, read the summary, and export the result.
Terminal and offline usage
Build the CLI, explore Ratatui, decode locally, and export JSON.
Run locally
Start the Rust API and Next.js frontend on your computer.
Run the API with Docker
Build the backend image, map its port, and connect the frontend.
QR images and Polar
Get an invoice, turn it into a QR, and import it into either client.
Understand validation
Read the individual checks and understand what they establish.
API and remote mode
Call the HTTP endpoints or connect the terminal client to an API.
Troubleshooting
Resolve connection errors, QR issues, and expected validation warnings.
The guides provide copy buttons and explain where each command runs. They do not execute commands on your computer. You can run HTTP requests through Swagger UI once your API is available.