From bed836f08ba38a06d263d6252a7dc42bc471aa32 Mon Sep 17 00:00:00 2001 From: nrslib <38722970+nrslib@users.noreply.github.com> Date: Tue, 3 Feb 2026 19:23:50 +0900 Subject: [PATCH] update README --- README.md | 27 ++++++++++++++++++++------- docs/README.ja.md | 27 ++++++++++++++++++++------- 2 files changed, 40 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e8f09bc..58fed8b 100644 --- a/README.md +++ b/README.md @@ -2,24 +2,37 @@ 🇯🇵 [日本語ドキュメント](./docs/README.ja.md) -**T**ask **A**gent **K**oordination **T**ool - Multi-agent orchestration system for Claude Code and OpenAI Codex +**T**ask **A**gent **K**oordination **T**ool - A governance-first orchestrator for running coding agents safely and responsibly + +TAKT coordinates AI agents like Claude Code and Codex according to your organization's rules and workflows. It clarifies who is responsible, what is permitted, and how to recover from failures, while automating complex development tasks. TAKT is built with TAKT itself (dogfooding). +## TAKT is For Teams That Need + +- **Want to integrate AI into CI/CD but fear runaway execution** — Clarify control scope with workflow definitions +- **Want automated PR generation but need audit logs** — Record and track all execution history +- **Want to use multiple AI models but manage them uniformly** — Control Claude/Codex/Mock with the same workflow +- **Want to reproduce and debug agent failures** — Maintain complete history with session logs and reports + +## What TAKT is NOT + +- **Not an autonomous engineer** — TAKT doesn't complete implementations itself; it governs and coordinates multiple agents +- **Not competing with Claude Code Swarm** — While leveraging Swarm's execution power, TAKT provides "operational guardrails" such as workflow definitions, permission controls, and audit logs +- **Not just a workflow engine** — TAKT is designed to address AI-specific challenges (non-determinism, accountability, audit requirements, and reproducibility) + ## Requirements -You need one of the following: +Choose one: -- **Anthropic API Key** or **OpenAI API Key** -- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) or [Codex](https://github.com/openai/codex) installed and configured +- **Use provider CLIs**: [Claude Code](https://docs.anthropic.com/en/docs/claude-code) or [Codex](https://github.com/openai/codex) installed +- **Use direct API**: **Anthropic API Key** or **OpenAI API Key** (no CLI required) Additionally required: - [GitHub CLI](https://cli.github.com/) (`gh`) — Only needed for `takt #N` (GitHub Issue execution) -**Pricing Note**: When using API Keys, TAKT directly calls the Claude API (Anthropic) or OpenAI API. This uses the same pricing structure as using Claude Code or Codex. Be mindful of costs, especially when running automated tasks in CI/CD environments, as API usage can accumulate. - -TAKT supports both Claude (Anthropic) and Codex (OpenAI) as providers. +**Pricing Note**: When using API Keys, TAKT directly calls the Claude API (Anthropic) or OpenAI API. The pricing structure is the same as using Claude Code or Codex. Be mindful of costs, especially when running automated tasks in CI/CD environments, as API usage can accumulate. ## Installation diff --git a/docs/README.ja.md b/docs/README.ja.md index e3949b9..e38aa53 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -1,23 +1,36 @@ # TAKT -**T**ask **A**gent **K**oordination **T**ool - Claude CodeとOpenAI Codex向けのマルチエージェントオーケストレーションシステム +**T**ask **A**gent **K**oordination **T**ool - AIエージェントを「安全に」「責任を持って」運用するための協調制御システム + +TAKTは、Claude CodeやCodexなどのAIエージェントを、組織のルールとワークフローに従って協調させます。誰が責任を持つか・どこまで許可するか・失敗時にどう戻すか を明確にしながら、複雑な開発タスクを自動化します。 TAKTはTAKT自身で開発されています（ドッグフーディング）。 +## TAKTが向いているチーム + +- **CI/CDにAIを組み込みたいが、暴走が怖い** — ワークフロー定義で制御範囲を明確化 +- **PRの自動生成をしたいが、監査ログが必要** — 全ての実行履歴を記録・追跡可能 +- **複数のAIモデルを使い分けたいが、統一的に管理したい** — Claude/Codex/モックを同じワークフローで制御 +- **エージェントの失敗を再現・デバッグしたい** — セッションログとレポートで完全な履歴を保持 + +## TAKTとは何でないか + +- **自律型AIエンジニアの代替ではありません** — TAKT自身が実装を完結するのではなく、複数のエージェントを統治・協調させます +- **Claude Code Swarmの競合ではありません** — Swarmの実行力を活かしつつ、TAKTはワークフロー/権限/監査ログなど「運用のガードレール」を提供します +- **単なるワークフローエンジンではありません** — 非決定性、責任所在、監査要件、再現性といったAI特有の課題に対応した設計です + ## 必要条件 -次のいずれかが必要です。 +次のいずれかを選択してください。 -- **Anthropic API Key** または **OpenAI API Key** -- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) または [Codex](https://github.com/openai/codex) がインストール・設定済みであること +- **プロバイダーCLIを使用**: [Claude Code](https://docs.anthropic.com/en/docs/claude-code) または [Codex](https://github.com/openai/codex) をインストール +- **API直接利用**: **Anthropic API Key** または **OpenAI API Key**（CLI不要） 追加で必要なもの: - [GitHub CLI](https://cli.github.com/) (`gh`) — `takt #N`（GitHub Issue実行）を使う場合のみ必要 -**料金について**: TAKT は API Key を使用する場合、Claude API（Anthropic）または OpenAI API を直接呼び出します。これは Claude Code や Codex を使った場合と同じ料金体系になります。特に CI/CD で自動実行する場合、API 使用量が増えるため、コストに注意してください。 - -TAKTは Claude（Anthropic）と Codex（OpenAI）の両方をプロバイダーとしてサポートしています。 +**料金について**: API Key を使用する場合、TAKT は Claude API（Anthropic）または OpenAI API を直接呼び出します。料金体系は Claude Code や Codex を使った場合と同じです。特に CI/CD で自動実行する場合、API 使用量が増えるため、コストに注意してください。 ## インストール