YNAB CLI

A command-line interface for interacting with YNAB (You Need A Budget).

Usage

Full user documentation available here

Project Structure

src/ynab_cli/: Main source code
tests/: Unit and integration tests
docs/: Documentation (built with MkDocs)

Getting Started

Prerequisites

Python 3.11+
uv

Installation

Clone the repository:

$ git clone https://github.com/jeffsawatzky/ynab-cli.git
$ cd ynab-cli

Install dependencies with uv:

$ uv sync

Running the CLI

With uv:

$ uv run ynab-cli --help

Development

Source code is in src/ynab_cli/.
Use feature branches for new work.
Follow PEP8 and use type hints where possible.

Linting & Formatting

$ make lint

Running Tests

$ make test

Or directly with pytest:

uv run pytest

Documentation

Docs are in docs/ and built with MkDocs.
To serve docs locally:

$ uv run mkdocs serve

Contributing

Fork the repository
Create a feature branch (git checkout -b feature/your-feature)
Commit your changes. Commits should follow conventional commits. The repo is configured with commitizen
Push to your fork and open a pull request

Please include tests for new features and bug fixes.

License

See LICENSE.md

Metadata

Release files for ynab-cli 0.8.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ynab-cli 0.8.2
File	Size	Uploaded
ynab_cli-0.8.2.tar.gz	280.0 kB	Sep 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ynab-cli 0.8.2
File	Interpreter	ABI	Platform	Reset
ynab_cli-0.8.2-py3-none-any.whl 270.4 kB Sep 30, 2026	Python 3	none	any	Details

Total release size: 550.4 kB

Release files / ynab_cli-0.8.2.tar.gz

Download URL	ynab_cli-0.8.2.tar.gz
Size	280.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`9a0123ae33c010052904546a8e2dffe7f70a02889624b36d2b85c4c50bc6f5da`
BLAKE2b-256 checksum How to use checksums	`7bd3bac0e9f41738f5f780d478a50c5ea22cd29fad9a044e116139d9f846a798`
Upload date	Sep 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/jeffsawatzky/ynab-cli
Publishing commit: github.com/jeffsawatzky/ynab-cli/tree/17fbc30c41adca4f797a6fab2bcdf2273512de40

Workflow

Publishing configuration: github.com/jeffsawatzky/ynab-cli/blob/17fbc30c41adca4f797a6fab2bcdf2273512de40/.github/workflows/publish-to-pypi.yml
Publishing logs: github.com/jeffsawatzky/ynab-cli/actions/runs/36771428276/attempts/1

Artifact

Subject: ynab_cli-0.8.2.tar.gz
SHA-256 checksum: 9a0123ae33c010052904546a8e2dffe7f70a02889624b36d2b85c4c50bc6f5da Verifying attestations

Release files / ynab_cli-0.8.2-py3-none-any.whl

Download URL	ynab_cli-0.8.2-py3-none-any.whl
Size	270.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`241f25400541513a6a5d2bab4c15cf6aa795f732adac6157e25fda2b5cffac1f`
BLAKE2b-256 checksum How to use checksums	`d114ed607142d37cb45bcdf1fcc54cb7338f683ab708394f74bf6c405533245a`
Upload date	Sep 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/jeffsawatzky/ynab-cli
Publishing commit: github.com/jeffsawatzky/ynab-cli/tree/17fbc30c41adca4f797a6fab2bcdf2273512de40

Workflow

Publishing configuration: github.com/jeffsawatzky/ynab-cli/blob/17fbc30c41adca4f797a6fab2bcdf2273512de40/.github/workflows/publish-to-pypi.yml
Publishing logs: github.com/jeffsawatzky/ynab-cli/actions/runs/36771428276/attempts/1

Artifact

Subject: ynab_cli-0.8.2-py3-none-any.whl
SHA-256 checksum: 241f25400541513a6a5d2bab4c15cf6aa795f732adac6157e25fda2b5cffac1f Verifying attestations