https://github.com/nef10/swiftbeancountcli

Command line tool for SwiftBeanCount
https://github.com/nef10/swiftbeancountcli

plaintext-accounting swiftbeancount

Last synced: 12 days ago
JSON representation

Command line tool for SwiftBeanCount

• Host: GitHub
• URL: https://github.com/nef10/swiftbeancountcli
• Owner: Nef10
• License: mit
• Created: 2020-06-01T05:25:19.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T01:10:52.000Z (7 months ago)
• Last Synced: 2024-05-02T13:16:37.821Z (6 months ago)
• Topics: plaintext-accounting, swiftbeancount
• Language: Swift
• Homepage: https://github.com/Nef10/SwiftBeanCount
• Size: 113 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SwiftBeanCountCLI

[![CI Status](https://github.com/Nef10/SwiftBeanCountCLI/workflows/CI/badge.svg?event=push)](https://github.com/Nef10/SwiftBeanCountCLI/actions?query=workflow%3A%22CI%22) [![License: MIT](https://img.shields.io/github/license/Nef10/SwiftBeanCountCLI)](https://github.com/Nef10/SwiftBeanCountCLI/blob/main/LICENSE) [![Latest version](https://img.shields.io/github/v/release/Nef10/SwiftBeanCountCLI?label=SemVer&sort=semver)](https://github.com/Nef10/SwiftBeanCountCLI/releases) ![platforms supported: linux | macOS](https://img.shields.io/badge/platform-linux%20%7C%20macOS-blue)

### ***This project is part for SwiftBeanCount, please check out the main documentation [here](https://github.com/Nef10/SwiftBeanCount).***

## What

This is the command line tool of SwiftBeanCount.

## Usage

As this is currently an alpha version, it only supports this very limited list of functions:

* `check` Parses your ledger and prints any errors it finds

* `stats` Statistics of a ledger (e.g. # of transactions)

* `accounts` Print all accounts

* `tax-slips` Outputs expected tax slips

## Installation

This executable is built using the Swift Package Manger, so it can be installed via [Mint](https://github.com/yonaskolb/Mint):

```

mint install Nef10/SwiftBeanCountCLI

```

### Completion

Thanks to the [swift-argument-parser](https://github.com/apple/swift-argument-parser) you can generate autocompletion scripts via `swiftbeancount --generate-completion-script {zsh|bash|fish}`. The exact command for your shell may vary, but for example for zsh with ~/.zfunctions in your fpath you can use:

```

swiftbeancount --generate-completion-script zsh > ~/.zfunctions/_swiftbeancount

```