Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 3.72 KB

README.ja.md

File metadata and controls

78 lines (51 loc) · 3.72 KB

okane オカネ

CircleCI crates.io

okane (オカネ)は ledger-cliフォーマットに準拠したプレーンテキスト帳簿アプリケーションです。

現在ツールが実装しているコマンドは下記のとおりです。

  • balance: 各アカウント(口座)の残高を表示します。
  • register: 指定口座の変動を表示します。仕訳帳に相当します。
  • accounts: アカウント(口座)の一覧を表示します。
  • format: Ledgerファイルのフォーマッターです。
  • import: 色々なデータファイル (CSV, ISO Camt053 XML)をLedgerフォーマットに取り込みます。
  • primitive: まだまともに使えるかよくわからないサブコマンドがまとめられています。

使用方法

注意: まだ開発中なので突然引数などが変わることがあります。

またサポートされている文法はsyntaxのとおりです。

インストール

まだバイナリのリリースはないので自分でcargo installしてください。

$ cargo install okane

なんならgit cloneして自分でビルドしたバイナリを使うくらいがおすすめです。

各種クエリ

ledger-cli同様のコマンドです。
ただオプション等はほぼないので今後に期待してください。

$ okane accounts /path/to/file.ledger
$ okane balance /path/to/file.ledger
$ okane registry /path/to/file.ledger [optional account]

format

$ okane format ~/ledger/account.ledger

現在は整形済みのテキストを標準出力に吐くだけになっています。近々inplaceの置換やdiffモード、recursiveオプションを実装したいと思っています。

CSV / ISO Camt053 XMLファイルの取り込み

import コマンドでは各種取引明細ファイルからLedgerフォーマットに取り込むことができます。摘要欄などに正規表現でマッチして仕訳できるようになっています。

まず最初にYAML形式の設定ファイルを用意します。このファイルで取り込み時に関する設定を行います。この例ではファイルが ~/ledger に保存されていると仮定します。 フォーマットはまだなんの解説もありませんが、 tests/testdata 以下のyamlをとりあえず参考にしてください。

その状態でまずは okane import コマンドを実行してください。読み込まれたLedgerフォーマットのデータは標準出力に吐かれるので、まず /dev/null にリダイレクトすると設定のエラーを確認できます。

$ RUST_LOG=info okane import --config ~/ledger/import.yml ~/ledger/input_file.csv > /dev/null

ログを読んである程度満足するまで設定ファイルを編集します。終えたらledgerファイルに追記で書き込みます。

$ RUST_LOG=info okane import --config ~/ledger/import.yml ~/ledger/input_file.csv >> ~/ledger/output_path.ledger

Tips: 100%の自動化を目指すと無理が出るので、80~90%程度自動化できるといいやくらいに思ってると楽です。

ライセンス

このツールは MIT lisence でライセンスされています。 作者はこのソフトウェアの使用上生じた問題については責任を負いかねます。