Skip to content

riaf/relqis

Repository files navigation

Relqis

Relqis は、AI エージェントと一緒に会計処理を進めることを主な利用形態として想定した会計エンジンです。内部では rlq CLI を使いますが、通常の利用者が日常的に CLI コマンドを覚える必要はありません。

ワークスペース

  • crates/rlq-cli: rlq コマンドのバイナリエントリポイント
  • crates/relqis-runtime: SQLite bootstrap と viewer/runtime facade
  • crates/relqis-application: アプリケーションサービス、DTO、アプリケーションエラー
  • crates/relqis-domain: ドメインプリミティブ、集約、値オブジェクト、bounded context
  • crates/relqis-infra-sqlite: SQLite リポジトリ、クエリリポジトリ、マイグレーション、unit-of-work 実装

基本的な使い方

Relqis は、会計用の作業ディレクトリを 1 つ作り、そのディレクトリを AI エージェントと一緒に運用する形を想定しています。

1. rlq を使える状態にする

最新の公開版は GitHub Releases から取得できます。nightly build を含む一覧は Releases 一覧 を参照してください。 シェルから rlq を実行できる状態にしてから、次の作業へ進みます。

2. 会計用の作業ディレクトリを作る

mkdir -p accounting-work/{data,imports,exports,notes}
cd accounting-work
git init
rlq skills install
rlq skills install --write-agents-template
  • rlq skills install.agents/skills/relqis/ に同梱 skill を展開します
  • rlq skills install --write-agents-template は workspace ルートに AGENTS.md のスターターを生成します
  • AGENTS.md でこの workspace の既定 DB を決めるので、通常の依頼では毎回 DB パスを書かなくて構いません
  • 専用の init コマンドはありません。data/company.db がなければ、最初の会計操作で自動作成されます

3. 好みの AI エージェントへ自然言語で依頼する

作業ディレクトリを Codex、ChatGPT、Claude などの AI エージェントで開き、AGENTS.md を読ませたうえで会計処理を依頼します。

  • 「2026年度の会計期間を用意してください」
  • 「4/10 の売上を下書きで登録し、内容確認まで進めてください。借方は現金、貸方は売上高です」
  • imports/2026-04-sales.csv を確認し、取り込めるかどうか判断してください」
  • 「今月の試算表を見せてください」

どのコマンドを使うか、どの DB を触るか、どこで事前確認を挟むかは、同梱 skill と AGENTS.md を読んだエージェント側が判断する前提です。詳細な運用例は docs/ai-agent-accounting.md を参照してください。

困ったときは次のページが入口になります。

ライセンス

Relqis の公開版ソースコードは GNU Affero General Public License v3.0 only (AGPL-3.0-only) で提供します。

AGPL は商用利用そのものを禁止しません。ただし、AGPL で足りない権利や別条件が必要な場合は、別途商用ライセンスを案内します。たとえば次のようなケースです。

  • クローズドな製品への組み込み
  • AGPL の相互公開義務なしでの再配布
  • 改変したネットワーク提供版を、AGPL が求める対応ソース開示なしで運用したい場合
  • OEM、再販、ホワイトラベル、保証、補償、SLA、商用サポートが必要な場合

詳細は LICENSECOMMERCIAL.mdTRADEMARKS.md を参照してください。

Agent Skills

Relqis は会計 CLI 本体とは別に、AI エージェント向けの project-local skill 配布もサポートします。

rlq skills install
rlq skills install --write-agents-template
rlq skills status --json
  • rlq skills install: カレントディレクトリ配下の .agents/skills/relqis に公式 skill を導入
  • rlq skills install --write-agents-template: 追加で workspace ルートに AGENTS.md のスターターも生成
  • rlq skills status: 導入状態を not_installed / up_to_date / drifted / modified / partial で確認
  • 生成された AGENTS.md は workspace ローカルの運用ファイルとして自由に編集でき、skills status の managed file には含まれない

詳細な運用例は docs/ai-agent-accounting.md を参照してください。

コントリビュート

Relqis は CLI ツールである前に会計エンジンである、という前提で設計しているため、変更前に AGENTS.mddocs/architecture.mddocs/contexts.md を確認し、bounded context と write-side / read-side の境界を崩さない変更を優先してください。

ライセンス整理の都合上、コード変更の提案はまず Issue で受け付けます。詳細は CONTRIBUTING.md を参照してください。

Requirements

  • Rust 1.94 以上

Tests

リポジトリルートで、最低限次を実行してください。

cargo check
cargo test

ドキュメントサイトを変更した場合は、追加で次も確認してください。

npm install
npm run docs:build

CLI のアプリケーションエラーは JSON の error.codeerror.category、およびカテゴリごとに安定した非ゼロ終了コードを返すため、統合テストでは単なる 1 ではなく個別の終了コードを検証してください。

Notes

  • 大きな変更よりも、小さく検証しやすい差分を優先してください

ドキュメント

詳細は docs/ にあります。公開サイト: https://riaf.github.io/relqis/

About

Relqis は、AI エージェントと一緒に会計処理を進めることを主な利用形態として想定した会計エンジンです。

Resources

License

Contributing

Stars

Watchers

Forks

Sponsor this project

 

Contributors