Skip to content

Commit 7c93cad

Browse files
authored
docs: add Japanese README, pull request #2 from eltociear/add-ja-doc
2 parents d61a2cf + 014ec48 commit 7c93cad

File tree

3 files changed

+282
-3
lines changed

3 files changed

+282
-3
lines changed

README.ja.md

Lines changed: 279 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,279 @@
1+
# CCS - Claude Code Switch
2+
3+
<div align="center">
4+
5+
![CCS Logo](docs/assets/ccs-logo-medium.png)
6+
7+
**1つのコマンドで、ダウンタイムなし、タスクごとに最適なモデルを選択**
8+
9+
Claude Sonnet 4.5、GLM 4.6、Kimi for Coding を瞬時に切り替え。レート制限を回避し、コストを最適化。
10+
11+
12+
[![License](https://img.shields.io/badge/license-MIT-C15F3C?style=for-the-badge)](LICENSE)
13+
[![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey?style=for-the-badge)]()
14+
[![npm](https://img.shields.io/npm/v/@kaitranntt/ccs?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@kaitranntt/ccs)
15+
[![PoweredBy](https://img.shields.io/badge/PoweredBy-ClaudeKit-C15F3C?style=for-the-badge)](https://claudekit.cc?ref=HMNKXOHN)
16+
17+
**Languages**: [English](README.md) | [Tiếng Việt](README.vi.md) | [日本語](README.ja.md)
18+
19+
</div>
20+
21+
---
22+
23+
## 🚀 クイックスタート
24+
25+
### 🔑 前提条件
26+
27+
**CCSをインストールする前に、サブスクリプションアカウントでClaude CLIにログインしていることを確認してください:**
28+
```bash
29+
claude /login
30+
```
31+
32+
### 主なインストール方法
33+
34+
#### オプション1: npmパッケージ(推奨)
35+
36+
**macOS / Linux / Windows**
37+
```bash
38+
npm install -g @kaitranntt/ccs
39+
```
40+
41+
npm、yarn、pnpm、bunパッケージマネージャーと互換性があります。
42+
43+
#### オプション2: 直接インストール(従来型)
44+
45+
**macOS / Linux**
46+
```bash
47+
curl -fsSL ccs.kaitran.ca/install | bash
48+
```
49+
50+
**Windows PowerShell**
51+
```powershell
52+
irm ccs.kaitran.ca/install | iex
53+
```
54+
55+
### 最初の切り替え
56+
57+
```bash
58+
# Claudeサブスクリプションを使用(デフォルト)
59+
ccs "このアーキテクチャ設計をレビューして"
60+
61+
# GLMに切り替えてコスト最適化されたタスクを実行
62+
ccs glm "シンプルなREST APIを作成して"
63+
64+
# Kimiに切り替えて別のオプションを使用
65+
ccs kimi "統合テストを書いて"
66+
67+
# 切り替えが戻されるまで、以降のすべてのコマンドでGLMを使用
68+
ccs glm
69+
ccs "この問題をデバッグして"
70+
ccs "ユニットテストを書いて"
71+
```
72+
73+
#### パッケージマネージャーオプション
74+
75+
主要なパッケージマネージャーすべてに対応:
76+
77+
```bash
78+
# npm(デフォルト)
79+
npm install -g @kaitranntt/ccs
80+
81+
# yarn
82+
yarn global add @kaitranntt/ccs
83+
84+
# pnpm(ディスク使用量70%削減)
85+
pnpm add -g @kaitranntt/ccs
86+
87+
# bun(30倍高速)
88+
bun add -g @kaitranntt/ccs
89+
```
90+
91+
### 設定(自動作成)
92+
93+
**CCSはインストール時に自動的に設定を作成します**(npm postinstallスクリプト経由)。
94+
95+
**~/.ccs/config.json**:
96+
```json
97+
{
98+
"profiles": {
99+
"glm": "~/.ccs/glm.settings.json",
100+
"kimi": "~/.ccs/kimi.settings.json",
101+
"default": "~/.claude/settings.json"
102+
}
103+
}
104+
```
105+
106+
### カスタムClaude CLIパス
107+
108+
Claude CLIが標準以外の場所(Dドライブ、カスタムディレクトリ)にインストールされている場合は、`CCS_CLAUDE_PATH`を設定してください:
109+
110+
```bash
111+
export CCS_CLAUDE_PATH="/path/to/claude" # Unix
112+
$env:CCS_CLAUDE_PATH = "D:\Tools\Claude\claude.exe" # Windows
113+
```
114+
115+
**詳細な設定手順については、[トラブルシューティングガイド](./docs/en/troubleshooting.md#claude-cli-in-non-standard-location)を参照してください。**
116+
117+
---
118+
119+
## 日常の開発者の課題
120+
121+
Claudeサブスクリプション、GLM Coding Plan、Kimi for Codingを持っている場合、毎日3つのシナリオが発生します:
122+
123+
1. **レート制限に達する**: Claudeがプロジェクト途中で停止 → 手動で`~/.claude/settings.json`を編集
124+
2. **コストの無駄**: 単純なタスクに高価なClaudeを使用 → GLMやKimiで十分
125+
3. **モデル選択**: タスクごとに異なるモデルの強みを活用 → 手動切り替え
126+
127+
手動切り替えはフローを中断します。**CCSはこれを瞬時に解決します**
128+
129+
## 手動切り替えではなくCCSを使う理由は?
130+
131+
<div align="center">
132+
133+
| 機能 | メリット | 感情的価値 |
134+
|---------|---------|-----------------|
135+
| **即座の切り替え** | 1つのコマンド、ファイル編集不要 | 自信、コントロール |
136+
| **ゼロダウンタイム** | ワークフローを中断しない | 信頼性、一貫性 |
137+
| **スマート委譲** | タスクごとに適切なモデルを自動選択 | シンプルさ、容易さ |
138+
| **コスト管理** | 必要な時だけ高価なモデルを使用 | 効率性、節約 |
139+
| **クロスプラットフォーム** | macOS、Linux、Windowsで動作 | 柔軟性、移植性 |
140+
| **信頼性** | 純粋なbash/PowerShell、依存関係なし | 信頼、安心 |
141+
142+
</div>
143+
144+
**ソリューション**:
145+
```bash
146+
ccs # Claudeサブスクリプションを使用(デフォルト)
147+
ccs glm # GLMフォールバックに切り替え
148+
ccs kimi # Kimi for Codingに切り替え
149+
# レート制限に達した?即座に切り替え:
150+
ccs glm # GLMで作業を続行
151+
# またはKimiに切り替え:
152+
ccs kimi # Kimiで作業を続行
153+
```
154+
155+
1つのコマンド。ダウンタイムなし。ファイル編集不要。適切なモデル、適切なタスク。
156+
157+
---
158+
159+
## 🏗️ アーキテクチャ概要
160+
161+
```mermaid
162+
graph LR
163+
subgraph "ユーザーコマンド"
164+
CMD[ccs glm]
165+
end
166+
167+
subgraph "CCS処理"
168+
CONFIG[~/.ccs/config.jsonを読み込み]
169+
LOOKUP[プロファイル → 設定ファイルを検索]
170+
VALIDATE[ファイル存在を検証]
171+
end
172+
173+
subgraph "Claude CLI"
174+
EXEC[claude --settings file_path]
175+
end
176+
177+
subgraph "APIレスポンス"
178+
API[Claude Sub または GLM API]
179+
end
180+
181+
CMD --> CONFIG
182+
CONFIG --> LOOKUP
183+
LOOKUP --> VALIDATE
184+
VALIDATE --> EXEC
185+
EXEC --> API
186+
```
187+
188+
---
189+
190+
## ⚡ 機能
191+
192+
### 即座のプロファイル切り替え
193+
- **1つのコマンド**: `ccs glm`でGLMに切り替え、`ccs`でClaudeサブスクリプションを使用 - 設定ファイルの編集不要
194+
- **スマート検出**: タスクごとに適切なモデルを自動使用
195+
- **永続的**: 再度変更されるまで切り替えは有効
196+
197+
### ワークフロー中断なし
198+
- **ダウンタイムなし**: コマンド間で即座に切り替え
199+
- **コンテキスト保持**: ワークフローは中断されない
200+
- **シームレスな統合**: ネイティブのClaude CLIと全く同じように動作
201+
202+
203+
---
204+
205+
## 💻 使用例
206+
207+
```bash
208+
ccs # Claudeサブスクリプションを使用(デフォルト)
209+
ccs glm # GLMフォールバックを使用
210+
ccs kimi # Kimi for Codingを使用
211+
ccs --version # CCSバージョンとインストール場所を表示
212+
```
213+
214+
---
215+
216+
### 🗑️ 公式アンインストール
217+
218+
**CCSを完全に削除する推奨方法:**
219+
220+
**macOS / Linux**:
221+
```bash
222+
curl -fsSL ccs.kaitran.ca/uninstall | bash
223+
```
224+
225+
**Windows PowerShell**:
226+
```powershell
227+
irm ccs.kaitran.ca/uninstall | iex
228+
```
229+
230+
> 💡 **公式アンインストーラーを使用する理由は?**
231+
> - すべてのCCSファイルと設定を削除
232+
> - PATH変更をクリーンアップ
233+
> - Claude CLIコマンド/スキルを削除
234+
> - テスト済みのエッジケースに対応
235+
236+
**代替方法**(公式アンインストーラーが失敗した場合):
237+
- **npm**: `npm uninstall -g @kaitranntt/ccs`
238+
- **手動**: [トラブルシューティングガイド](./docs/en/troubleshooting.md#manual-uninstall)を参照
239+
240+
---
241+
242+
## 🎯 哲学
243+
244+
- **YAGNI**: 「念のため」の機能は追加しない
245+
- **KISS**: シンプルなbash、複雑さなし
246+
- **DRY**: 単一の情報源(設定)
247+
248+
---
249+
250+
## 📖 ドキュメント
251+
252+
**[docs/](./docs/)の完全なドキュメント**:
253+
- [インストールガイド](./docs/en/installation.md)
254+
- [設定](./docs/en/configuration.md)
255+
- [使用例](./docs/en/usage.md)
256+
- [トラブルシューティング](./docs/en/troubleshooting.md)
257+
- [コントリビューション](./docs/en/contributing.md)
258+
259+
---
260+
261+
## 🤝 コントリビューション
262+
263+
コントリビューションを歓迎します!詳細については[コントリビューションガイド](./docs/en/contributing.md)をご覧ください。
264+
265+
---
266+
267+
## 📄 ライセンス
268+
269+
CCSは[MITライセンス](LICENSE)の下でライセンスされています。
270+
271+
---
272+
273+
<div align="center">
274+
275+
**レート制限に頻繁に遭遇する開発者のために ❤️ を込めて作成**
276+
277+
[⭐ このリポジトリにスター](https://github.com/kaitranntt/ccs) | [🐛 問題を報告](https://github.com/kaitranntt/ccs/issues) | [📖 ドキュメントを読む](./docs/en/)
278+
279+
</div>

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Switch between Claude Sonnet 4.5, GLM 4.6, and Kimi for Coding instantly. Stop h
1414
[![npm](https://img.shields.io/npm/v/@kaitranntt/ccs?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@kaitranntt/ccs)
1515
[![PoweredBy](https://img.shields.io/badge/PoweredBy-ClaudeKit-C15F3C?style=for-the-badge)](https://claudekit.cc?ref=HMNKXOHN)
1616

17-
**Languages**: [English](README.md) | [Tiếng Việt](README.vi.md)
17+
**Languages**: [English](README.md) | [Tiếng Việt](README.vi.md) | [日本語](README.ja.md)
1818

1919
</div>
2020

@@ -312,4 +312,4 @@ CCS is licensed under the [MIT License](LICENSE).
312312

313313
[⭐ Star this repo](https://github.com/kaitranntt/ccs) | [🐛 Report issues](https://github.com/kaitranntt/ccs/issues) | [📖 Read docs](./docs/en/)
314314

315-
</div>
315+
</div>

README.vi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Chuyển đổi giữa Claude Sonnet 4.5 và GLM 4.6 ngay lập tức. Ngừng h
1313
[![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey?style=for-the-badge)]()
1414
[![PoweredBy](https://img.shields.io/badge/PoweredBy-ClaudeKit-C15F3C?style=for-the-badge)](https://claudekit.cc?ref=HMNKXOHN)
1515

16-
**Ngôn ngữ**: [English](README.md) | [Tiếng Việt](README.vi.md)
16+
**Ngôn ngữ**: [English](README.md) | [Tiếng Việt](README.vi.md) | [日本語](README.ja.md)
1717

1818
</div>
1919

0 commit comments

Comments
 (0)