shuho 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +49 -0
- package/README.md +72 -0
- package/dist/index.js +1252 -0
- package/package.json +63 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
shuho ソフトウェア使用許諾契約
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Yoshiaki Sakae. All rights reserved.
|
|
4
|
+
|
|
5
|
+
本契約は、ソフトウェア「shuho」(以下「本ソフトウェア」)の使用条件を定める
|
|
6
|
+
ものです。本ソフトウェアをインストールまたは使用した時点で、利用者は本契約
|
|
7
|
+
に同意したものとみなされます。
|
|
8
|
+
|
|
9
|
+
第1条(使用許諾)
|
|
10
|
+
権利者は、利用者に対し、本ソフトウェアを利用者自身の業務または個人利用の
|
|
11
|
+
目的でインストールし使用する、非独占的かつ譲渡不能な権利を許諾します。
|
|
12
|
+
|
|
13
|
+
第2条(Pro プラン)
|
|
14
|
+
本ソフトウェアの一部機能(GitHub API 連携、複数クライアント管理等)の利用
|
|
15
|
+
には、権利者が発行する有効なライセンスキーが必要です。ライセンスキーの発行
|
|
16
|
+
条件および料金は、権利者が別途定めるところによります。
|
|
17
|
+
|
|
18
|
+
第3条(禁止事項)
|
|
19
|
+
利用者は、以下の行為を行ってはなりません。
|
|
20
|
+
1. 本ソフトウェアの再頒布、販売、貸与、またはサブライセンス
|
|
21
|
+
2. 本ソフトウェアの改変、翻案、または派生物の作成
|
|
22
|
+
3. リバースエンジニアリング、逆コンパイル、または逆アセンブル
|
|
23
|
+
(法令により明示的に認められる場合を除く)
|
|
24
|
+
4. ライセンスキーの共有・転売、またはライセンス検証機構の回避による
|
|
25
|
+
有償機能の不正利用
|
|
26
|
+
|
|
27
|
+
第4条(成果物の帰属)
|
|
28
|
+
本ソフトウェアを用いて利用者が生成した週報等の成果物に関する権利は、
|
|
29
|
+
利用者に帰属します。
|
|
30
|
+
|
|
31
|
+
第5条(プライバシー)
|
|
32
|
+
本ソフトウェアが外部の LLM サービスへ送信する情報は、コミットメッセージ
|
|
33
|
+
および Pull Request / Issue のタイトルと本文のみであり、ソースコードの
|
|
34
|
+
本文や差分は送信されません。送信先は利用者自身が設定した LLM バックエンド
|
|
35
|
+
(利用者自身のアカウントまたはサブスクリプション)に限られます。
|
|
36
|
+
|
|
37
|
+
第6条(無保証)
|
|
38
|
+
本ソフトウェアは「現状有姿」で提供されます。権利者は、本ソフトウェアの
|
|
39
|
+
完全性、正確性、有用性、または特定目的への適合性について、いかなる保証も
|
|
40
|
+
行いません。生成された文書の内容の確認および送付は、利用者自身の責任で
|
|
41
|
+
行ってください。
|
|
42
|
+
|
|
43
|
+
第7条(責任制限)
|
|
44
|
+
権利者は、本ソフトウェアの使用または使用不能から生じるいかなる損害に
|
|
45
|
+
ついても、法令上許容される最大限の範囲で責任を負わないものとします。
|
|
46
|
+
|
|
47
|
+
第8条(準拠法および管轄)
|
|
48
|
+
本契約は日本法に準拠します。本契約に関して紛争が生じた場合、権利者の
|
|
49
|
+
所在地を管轄する裁判所を第一審の専属的合意管轄裁判所とします。
|
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# shuho
|
|
2
|
+
|
|
3
|
+
GitHub の活動履歴から、**非エンジニアのクライアント向け週報の下書き**を 1 コマンドで生成する CLI ツールです。毎週 30〜60 分かかる報告書作成を、3 分のレビュー作業に変えます。
|
|
4
|
+
|
|
5
|
+
> **現在ベータ版(v0.x)です。** 不具合のご報告・ご意見は support@alforgelabs.com までお寄せください。
|
|
6
|
+
|
|
7
|
+
## 特長
|
|
8
|
+
|
|
9
|
+
- **技術ログをクライアントの言葉に翻訳**: コミット・PR・Issue を、非エンジニアが読める日本語の成果報告に変換します。
|
|
10
|
+
- **追加費用ゼロで動く**: Claude Code / Codex のサブスクリプションを利用中なら、API キー設定も追加課金も不要です(CLI バックエンド)。
|
|
11
|
+
- **成果物は下書き**: 最終確認と送信は人間が行う前提です。
|
|
12
|
+
|
|
13
|
+
## プライバシー(重要)
|
|
14
|
+
|
|
15
|
+
- LLM へ送信するのは **コミットメッセージ、PR / Issue のタイトルと本文のみ** です。
|
|
16
|
+
- **diff およびコード本文は一切送信しません**。
|
|
17
|
+
- API モード(`anthropic` / `openai`)は BYOK のため、データの行き先はユーザー自身のアカウントのみです。CLI モードはユーザー自身のサブスクリプション経由です。
|
|
18
|
+
|
|
19
|
+
## LLM バックエンド
|
|
20
|
+
|
|
21
|
+
| provider | 認証 | 備考 |
|
|
22
|
+
| ------------ | -------------------------- | ------------------------------------- |
|
|
23
|
+
| `claude-cli` | 不要(Claude Code サブスク) | 追加課金ゼロ。推奨 |
|
|
24
|
+
| `codex-cli` | 不要(ChatGPT サブスク) | 追加課金ゼロ |
|
|
25
|
+
| `anthropic` | `ANTHROPIC_API_KEY` | Anthropic SDK(既定 `claude-opus-4-8`) |
|
|
26
|
+
| `openai` | `OPENAI_API_KEY` | OpenAI SDK |
|
|
27
|
+
|
|
28
|
+
## コマンド
|
|
29
|
+
|
|
30
|
+
```sh
|
|
31
|
+
shuho init # 初期設定(GitHub認証・LLMバックエンド選択)
|
|
32
|
+
shuho client add <name> # クライアント(案件)を登録
|
|
33
|
+
shuho client list # 一覧
|
|
34
|
+
shuho client remove <name> # 削除
|
|
35
|
+
shuho generate [--client <name>] [--week <n>] # 週報の下書きを生成(--week 2 で2週前)
|
|
36
|
+
shuho license <key> # Pro ライセンスキーの設定と検証
|
|
37
|
+
shuho doctor # 疎通確認
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
- 設定ファイル: `~/.config/shuho/config.toml`
|
|
41
|
+
- 週報の出力先: カレントディレクトリの `shuho-<クライアント名>-YYYY-MM-DD.md`(日付は対象週の月曜)
|
|
42
|
+
|
|
43
|
+
## プラン
|
|
44
|
+
|
|
45
|
+
| プラン | データソース | クライアント数 |
|
|
46
|
+
| ------ | --------------------------------- | -------------- |
|
|
47
|
+
| Free | ローカル git log(コミットのみ) | 1 件 |
|
|
48
|
+
| Pro | GitHub API(コミット / PR / Issue) | 無制限 |
|
|
49
|
+
|
|
50
|
+
### Pro プランの購入
|
|
51
|
+
|
|
52
|
+
- 年額プラン(¥9,800/年・推奨): https://buy.polar.sh/polar_cl_N5LskedNAoeC7oPO7Rh0Co8Ptmf4t5mgpRqMA4Fw3zZ
|
|
53
|
+
- 購入後に届くライセンスキーを設定してください:
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
npx shuho license <購入時に発行されたキー>
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
(設定と同時にキーの有効性を検証します。`~/.config/shuho/config.toml` の手動編集でも設定可能です)
|
|
60
|
+
|
|
61
|
+
- ライセンスキーは購入完了ページ、または Polar カスタマーポータル(購入確認メール内のリンク)の注文詳細で確認できます
|
|
62
|
+
|
|
63
|
+
お問い合わせ: support@alforgelabs.com
|
|
64
|
+
|
|
65
|
+
## 動作環境
|
|
66
|
+
|
|
67
|
+
- Node.js 20 以上
|
|
68
|
+
- インストール不要で実行できます: `npx shuho <コマンド>`(`npm install -g shuho` でも利用可)
|
|
69
|
+
|
|
70
|
+
## ライセンス
|
|
71
|
+
|
|
72
|
+
プロプライエタリライセンスです。使用条件は [LICENSE](LICENSE) を参照してください(再頒布・改変は禁止。生成した週報の権利は利用者に帰属します)。
|