Skip to content

Commit 6b81f07

Browse files
var-ggclaude
andcommitted
docs(readme): add Japanese translation + download section
- New README.ja.md; the language switcher is now English · 한국어 · 日本語 across all three files. - Add a Download section + release badge linking to the Releases page — the README previously documented only building from source, leaving non-developer visitors with no path to a binary. - Bump the stale v0.1 references to v0.2 and rename the version-pinned "What v0.1 ships" header to "Features" so it stops rotting. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent bcd10cf commit 6b81f07

3 files changed

Lines changed: 158 additions & 6 deletions

File tree

README.ja.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# gitwink
2+
3+
[English](README.md) · [한국어](README.ko.md) · **日本語**
4+
5+
[![Release](https://img.shields.io/github/v/release/var-gg/gitwink)](https://github.com/var-gg/gitwink/releases/latest)
6+
7+
> AIエージェント時代のための、トレイ常駐・読み取り専用 git glance。
8+
9+
**ステータス:** v0.2 — 実用段階。コールドスタートに優しいトレイアプリ。
10+
11+
![gitwink](docs/images/hero.gif)
12+
13+
gitwink はシステムトレイに常駐する。クリックすると、**すべて**のローカル
14+
リポジトリの最近のコミット活動をひと目で確認できる。git **クライアント
15+
ではない** — commit・push・merge・変更、いずれもできない。設計上、
16+
読み取り専用。
17+
18+
## ダウンロード
19+
20+
[**最新リリースをダウンロード →**](https://github.com/var-gg/gitwink/releases/latest)
21+
22+
- **Windows**`.exe`(NSIS インストーラ)または `.msi`
23+
- **macOS**`.dmg`(universal)
24+
25+
現時点で成果物は署名されていないため、初回起動時に Windows SmartScreen /
26+
macOS Gatekeeper が警告を出す — 回避手順はリリースノートに記載。自分で
27+
ビルドしたい場合は [開発](#開発) を参照。
28+
29+
## なぜ作ったか
30+
31+
以前は VS Code に GitLens を常駐させて生活していた。ブランチグラフ、
32+
ヒートマップ化された blame、lens のアノテーション — それが *私の* git
33+
ワークフローだった。そして 2025 年が来た。Cursor、Claude Code、Codex が
34+
実際の編集をこなすようになり、エディタそのものが任意の存在になった。
35+
それでも私を VS Code に引き戻す唯一の理由が GitLens だった。
36+
37+
それは無駄に思えた — コミット履歴をちょっと覗くためだけに IDE を丸ごと
38+
起動するのが。git コマンドはもうエージェントが打つ。私はたまに、何かが
39+
おかしく見えたときだけ、結果をざっと確認したいだけだ。gitwink は *その*
40+
ループに合わせた、可能な限り最小のツールだ — トレイアイコンが展開して
41+
ひと目を提供し、コミットを AI コンテキストとして渡し、そして退く。
42+
43+
commit なし。push なし。merge なし。git の手術が必要なら、エージェント
44+
に頼む。
45+
46+
## ループ
47+
48+
0.5 秒の確認ループ:
49+
50+
```
51+
エージェントがコミット → トレイをクリック → インライン展開 → "Copy as AI context"
52+
→ Claude/Codex に貼り付け
53+
→ 「エージェントは正しくやったか?」
54+
```
55+
56+
## 機能
57+
58+
- システムトレイアイコン(Windows トレイ / macOS メニューバー)。
59+
クリックでトグル、右クリックで 位置リセット / 設定ファイルを開く /
60+
終了。
61+
- グローバルホットキー `Ctrl+Shift+G`(Windows)/ `Cmd+Shift+G`
62+
(macOS)でどこからでもパネルを呼び出し・解除。`settings.json`
63+
`panel_hotkey` を編集すれば変更可能(トレイを右クリック →
64+
「Open settings file…」)。Tauri のショートカット仕様なら何でも
65+
指定でき、例えば `"Alt+Space"``"Ctrl+Alt+Backquote"` など。
66+
適用には再起動が必要。
67+
- 初回起動時にデフォルトのユーザーディレクトリを探索(`source`
68+
`Documents``Projects``Code``Dev``repos``Desktop`、Windows
69+
ではすべての非システムドライブ / macOS では `~/Projects``~/Code`
70+
`~/Documents``~/Developer`)。結果は
71+
`%APPDATA%\gg.var.gitwink\cache.db` の SQLite にキャッシュ。
72+
- すべてのリポジトリを横断する統合コミットタイムライン。上部のチップ
73+
でフィルタ: Repo(検索 + ピン留め)、期間(24h / 3d / 7d / 30d /
74+
All)、作成者(カウント付き複数選択)。
75+
- 行ごとのマーカー — `` コミット · `` マージ · `` タグ付き。現在
76+
チェックアウト中のブランチに無いコミットにはブランチラベルバッジ。
77+
- 単一リポジトリモード: リポジトリを 1 つ選ぶとパネルがブランチ別
78+
ビューに切り替わる。カスタム SVG DAG レーン描画(8 色パレット、
79+
ブランチ名からハッシュ生成。main / master / develop はニュートラル色)。
80+
- クリックでインライン展開: コミットメッセージ本文 + 変更ファイル
81+
一覧(NEW/MOD/REN/DEL バッジ、`+/−` 行数、バイナリは `bin` +
82+
サイズ、GitLens スタイルのファイル名強調)。
83+
- 独立した diff ウィンドウ(シングルトン、再利用、位置・サイズ +
84+
最大化状態を永続化)でフル表示: ファイルサイドバー + 横スクロール
85+
同期の side-by-side diff。PNG / JPG / GIF / WebP / SVG の画像
86+
プレビュー内蔵(チェッカー背景、before / after)。ローカルの
87+
Git LFS オブジェクトは自動で参照。見つからない場合はインラインで
88+
説明。
89+
- Copy as AI context — `c` キーまたはボタン — コミット、ファイル
90+
一覧、(十分小さければ)diff 全体を Markdown ブロックとして出力。
91+
Claude / Codex / Cursor にそのまま貼り付け可能。
92+
93+
## Diff ウィンドウ
94+
95+
*「待って、エージェントは本当にそれをやった?」* と思った瞬間のために。
96+
任意のコミットをクリックすると独立したウィンドウが開く — フルの
97+
ファイルサイドバー、横スクロール同期の side-by-side diff、バイナリ
98+
アセットのインライン画像プレビュー、そして 位置・サイズ・最大化状態を
99+
記憶するシングルトンインスタンス。
100+
101+
![diff window](docs/images/diff.gif)
102+
103+
## 技術スタック
104+
105+
Tauri 2 · Rust · React + TypeScript · `git2` · SQLite · カスタム SVG
106+
DAG 描画 · テレメトリなし、フォンホームなし、ネットワークなし。
107+
108+
## 開発
109+
110+
```bash
111+
pnpm install
112+
pnpm tauri dev
113+
```
114+
115+
必要環境: Node 20+、Rust stable(Windows では msvc ツールチェーン)、
116+
Visual C++ Build Tools(Windows)または Xcode CLT(macOS)。
117+
118+
## プラットフォーム
119+
120+
- Windows 10/11 — 主要ターゲット、開発機で検証済み
121+
- macOS 13+ — 動作するはず、検証は少なめ
122+
- Linux — 後日
123+
124+
## ライセンス
125+
126+
[MIT](LICENSE)

README.ko.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,30 @@
11
# gitwink
22

3-
[English](README.md) · **한국어**
3+
[English](README.md) · **한국어** · [日本語](README.ja.md)
4+
5+
[![Release](https://img.shields.io/github/v/release/var-gg/gitwink)](https://github.com/var-gg/gitwink/releases/latest)
46

57
> AI 에이전트 시대를 위한 트레이 상주 · 읽기 전용 git glance.
68
7-
**상태:** v0.1 — 쓸 만함. cold-start 친화적인 트레이 앱.
9+
**상태:** v0.2 — 쓸 만함. cold-start 친화적인 트레이 앱.
810

911
![gitwink](docs/images/hero.gif)
1012

1113
gitwink는 시스템 트레이에 산다. 클릭하면 **모든** 로컬 repo의 최근
1214
커밋 활동을 한눈에 본다. git **클라이언트가 아니다** — commit, push,
1315
merge, 수정 어느 것도 못 한다. 설계상 읽기 전용.
1416

17+
## 다운로드
18+
19+
[**최신 릴리즈 다운로드 →**](https://github.com/var-gg/gitwink/releases/latest)
20+
21+
- **Windows**`.exe` (NSIS 인스톨러) 또는 `.msi`
22+
- **macOS**`.dmg` (universal)
23+
24+
현재 아티팩트는 서명되지 않아, 첫 실행 시 Windows SmartScreen / macOS
25+
Gatekeeper가 경고를 띄운다 — 우회 방법은 릴리즈 노트에 있다. 직접
26+
빌드하려면 [개발](#개발) 참고.
27+
1528
## 만든 이유
1629

1730
원래 VS Code에 GitLens 박아두고 살았다. 브랜치 그래프, 히트맵
@@ -39,7 +52,7 @@ commit 없음. push 없음. merge 없음. git 수술이 필요하면
3952
→ "에이전트가 제대로 했나?"
4053
```
4154

42-
## v0.1에 들어간 것
55+
## 기능
4356

4457
- 시스템 트레이 아이콘 (Windows 트레이 / macOS 메뉴바). 클릭으로
4558
토글, 우클릭으로 위치 리셋 / 설정 파일 열기 / 종료.

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,30 @@
11
# gitwink
22

3-
**English** · [한국어](README.ko.md)
3+
**English** · [한국어](README.ko.md) · [日本語](README.ja.md)
4+
5+
[![Release](https://img.shields.io/github/v/release/var-gg/gitwink)](https://github.com/var-gg/gitwink/releases/latest)
46

57
> Tray-resident, read-only git glance for the AI-agent era.
68
7-
**Status:** v0.1 — usable. Cold-start friendly tray app.
9+
**Status:** v0.2 — usable. Cold-start friendly tray app.
810

911
![gitwink](docs/images/hero.gif)
1012

1113
gitwink lives in your system tray. Click it to glance at recent commit
1214
activity across **all** your local repos. It is **not** a git client — it
1315
cannot commit, push, merge, or modify anything. Read-only by design.
1416

17+
## Download
18+
19+
[**Download the latest release →**](https://github.com/var-gg/gitwink/releases/latest)
20+
21+
- **Windows**`.exe` (NSIS installer) or `.msi`
22+
- **macOS**`.dmg` (universal)
23+
24+
Artefacts are unsigned for now, so Windows SmartScreen / macOS Gatekeeper
25+
will warn on first launch — the release notes have the bypass steps.
26+
Prefer to build it yourself? See [Development](#development).
27+
1528
## Origin
1629

1730
I used to live in VS Code with GitLens pinned. The branch graph,
@@ -39,7 +52,7 @@ agent commits → tray click → inline expand → "Copy as AI context"
3952
→ "did the agent do this right?"
4053
```
4154

42-
## What v0.1 ships
55+
## Features
4356

4457
- System tray icon (Windows tray / macOS menu bar) with click-to-toggle
4558
and right-click Reset position / Open settings file / Quit.

0 commit comments

Comments
 (0)