| name | animaworks-guide |
| description | animaworksコマンドの完全リファレンス。サーバー操作・Anima管理・モデル・タスク・設定・RAG・資産・外部ツールのCLI書式をまとめる。 Use when: サブコマンドの書式確認、サーバー起動停止、Anima作成・モデル変更・タスク追加・ログ・設定・インデックス操作が必要なとき。 |
AnimaWorks CLI 完全リファレンス
AnimaWorks の操作は全て animaworks コマンドで行う。
このスキルは全サブコマンドの書式・引数・具体例をまとめたリファレンス。
運用の考え方やルールは common_knowledge/ および reference/ を参照:
- メッセージングのルール →
communication/messaging-guide.md
- タスク管理 →
operations/task-management.md
- ツール体系 →
operations/tool-usage-overview.md
- 組織構造 →
reference/organization/structure.md
- モデル選択・設定 →
reference/operations/model-guide.md
非推奨・互換エイリアス
animaworks list
animaworks create-anima ...
animaworks chat {名前} "..." --local
animaworks heartbeat {名前} --local
推奨: animaworks start(または serve)でサーバーを起動し、--local を付けずに chat / heartbeat を使う。
gateway / worker サブコマンドは非表示の互換用(分散アーキ廃止後は使用しない)。
サーバー操作(基本的には使わないこと)
animaworks start
animaworks serve
animaworks start --host 127.0.0.1
animaworks start --port 8080
animaworks start --foreground
animaworks stop
animaworks stop --force
animaworks restart
animaworks restart --force
animaworks status
animaworks reset
animaworks reset --restart
Anima管理(anima サブコマンド)
一覧・状態・詳細情報
animaworks anima list
animaworks anima list --local
animaworks anima status
animaworks anima status {名前}
animaworks anima info {名前}
animaworks anima info {名前} --json
animaworks anima permissions {名前}
anima info の出力項目:
- Anima名、Enabled、Role、Model、Execution Mode(組み込みラベルは主に S/C/A/B。D・G 等は解決値がそのまま表示されうる)
- Credential、Fallback Model、Max Turns、Max Chains
- Context Threshold、Max Tokens、LLM Timeout
- Thinking / Thinking Effort、Supervisor、Mode S Auth
- Voice設定(tts_provider、voice_id、speed、pitch 等、status.json の voice 辞書を列挙)
作成
animaworks anima create --from-md {ファイル} [--role {role}] [--name {名前}]
animaworks anima create --template {テンプレート名} [--name {名前}]
animaworks anima create --name {名前}
有効化・無効化・削除
animaworks anima enable {名前}
animaworks anima disable {名前}
animaworks anima delete {名前}
animaworks anima delete {名前} --no-archive
animaworks anima delete {名前} --force
animaworks anima restart {名前}
活動監査(audit)
対象 Anima の activity_log を読む(ヘルプ文言は subordinate だが、名前を指定すれば任意の Anima で可)。
animaworks anima audit {名前}
animaworks anima audit {名前} --days 7
animaworks anima audit --all
animaworks anima audit {名前} --since 09:00
animaworks anima audit {名前} --mode summary
モデル変更
animaworks anima set-model {名前} {モデル名}
animaworks anima set-model {名前} {モデル名} --credential {credential名}
animaworks anima set-model --all {モデル名}
変更後にサーバーが起動中の場合は anima restart {名前} が必要。
バックグラウンドモデル(Heartbeat/Cron用)
animaworks anima set-background-model {名前} {モデル名}
animaworks anima set-background-model {名前} {モデル名} --credential {credential名}
animaworks anima set-background-model {名前} --clear
animaworks anima set-background-model --all --clear
animaworks anima set-background-model --all {モデル名}
アウトバウンド制限
animaworks anima set-outbound-limit {名前} --per-hour 30 --per-day 100
animaworks anima set-outbound-limit {名前} --per-run 5
animaworks anima set-outbound-limit {名前} --clear
名前変更
animaworks anima rename {旧名前} {新名前}
animaworks anima rename {旧名前} {新名前} --force
ロール変更
animaworks anima set-role {名前} {role}
animaworks anima set-role {名前} {role} --status-only
animaworks anima set-role {名前} {role} --no-restart
set-role で自動更新されるファイル(--status-only 以外):
status.json — role およびロール defaults.json 由来の model / max_turns 等をマージ
specialty_prompt.md — ロールテンプレートから上書き
permissions.json — ロールテンプレートから上書き(従来の permissions.md は読み込み時に JSON へ移行されうる)
有効なロール: engineer, researcher, manager, writer, ops, general
ホットリロード
animaworks anima reload {名前}
animaworks anima reload --all
モデル情報(models サブコマンド)
animaworks models
animaworks models list
animaworks models list --mode S
animaworks models list --json
animaworks models info {モデル名}
animaworks models show
animaworks models show --json
models list に無いモデル(例: cursor/*, gemini/*)は models info <名前> と models.json で確認する。
詳細 → reference/operations/model-guide.md
チャット・メッセージング
animaworks chat {名前} "メッセージ"
animaworks chat {名前} "メッセージ" --from {送信者名}
animaworks chat {名前} "メッセージ" --local
animaworks send {送信者} {受信者} "メッセージ"
animaworks send {送信者} {受信者} "メッセージ" --intent report
animaworks send {送信者} {受信者} "メッセージ" --reply-to {メッセージID}
animaworks send {送信者} {受信者} "メッセージ" --thread-id {スレッドID}
animaworks heartbeat {名前}
animaworks heartbeat {名前} --local
Board(共有チャネル)
animaworks board read {チャネル名}
animaworks board read {チャネル名} --limit 50
animaworks board read {チャネル名} --human-only
animaworks board post {送信者} {チャネル名} "テキスト"
animaworks board dm-history {自分} {相手}
animaworks board dm-history {自分} {相手} --limit 50
設定管理(config サブコマンド)
animaworks config
animaworks config -i
animaworks config list
animaworks config list --section system
animaworks config list --show-secrets
animaworks config get {キー}
animaworks config get {キー} --show-secrets
animaworks config set {キー} {値}
animaworks config export-sections
animaworks config export-sections --dry-run
注意: Animaのモデル・credential等は status.json がSSoT。animas.{名前}.model 等の直接設定は非推奨。animaworks anima set-model を使用すること。
プロファイル(profile サブコマンド・マルチテナント)
複数のAnimaWorksインスタンス(別データディレクトリ)を管理する。
animaworks profile list
animaworks profile add {名前}
animaworks profile add {名前} --data-dir /path/to/data --port 18510
animaworks profile remove {名前}
animaworks profile start {名前}
animaworks profile stop {名前}
animaworks profile stop {名前} --force
animaworks profile start-all
animaworks profile stop-all
animaworks profile stop-all --force
ログ閲覧(logs)
animaworks logs {名前}
animaworks logs --all
animaworks logs {名前} --lines 100
animaworks logs {名前} --date 20260301
コスト確認(cost)
animaworks cost
animaworks cost {名前}
animaworks cost --today
animaworks cost --days 7
animaworks cost --json
タスク管理(task サブコマンド)
前提: 実行前に ANIMAWORKS_ANIMA_DIR を対象 Anima のディレクトリ(例: ~/.animaworks/animas/{名前})に設定すること。未設定だとエラーになる(Anima 子プロセス内の animaworks-tool task や、シェルで変数を付与した animaworks task が想定用途)。
animaworks task list
animaworks task list --status pending
animaworks task add --assignee {名前} --instruction "タスク内容"
animaworks task add --assignee {名前} --instruction "内容" --source human --deadline 2026-03-10T18:00:00
animaworks task add ... --relay-chain alice,bob
animaworks task add ... --summary "1行要約"
animaworks task update --task-id {ID} --status done
animaworks task update --task-id {ID} --status done --summary "完了サマリー"
RAGインデックス管理
依存: RAG スタック未インストール時は pip install 'animaworks[rag]' が必要(CLI がエラー表示して終了)。
animaworks index
animaworks index --anima {名前}
animaworks index --anima {名前} --shared
animaworks index --full
animaworks index --dry-run
- conversation_summary:
state/conversation.json の compressed_summary をインデックス対象に含める(該当ファイルがある場合)。
- L2 距離の既存コレクション: サーバー非稼働でローカル Chroma に直接触る場合、
--full なしだと cosine 移行の警告が出ることがある(メッセージに従い --full を実行)。
- サーバー起動中:
server.pid 検出時、CLI は ANIMAWORKS_VECTOR_URL / ANIMAWORKS_EMBED_URL を設定して HTTP 経由でインデックス・埋め込みを行い、Chroma の同時アクセス競合を避ける。
- 埋め込みモデル:
index_meta.json の記録と設定が異なる場合、--full なしではエラー終了する。
ランタイム移行(migrate)
animaworks migrate
animaworks migrate --dry-run
animaworks migrate --verbose
animaworks migrate --list
animaworks migrate --force
animaworks migrate --resync-db
実行中サーバーがあると警告が出る。~/.animaworks/config.json が無い場合は失敗する。
アセット操作
アセット最適化
animaworks optimize-assets
animaworks optimize-assets --anima {名前}
animaworks optimize-assets --dry-run
animaworks optimize-assets --all
animaworks optimize-assets --simplify
animaworks optimize-assets --simplify 0.2
animaworks optimize-assets --texture-compress
animaworks optimize-assets --texture-resize 512
animaworks optimize-assets --skip-backup
アセット再生成(Vibe Transfer)
animaworks remake-assets {名前} --style-from {参照Anima}
animaworks remake-assets {名前} --style-from {参照} --steps fullbody,icon
animaworks remake-assets {名前} --style-from {参照} --prompt "..."
animaworks remake-assets {名前} --style-from {参照} --vibe-strength 0.6
animaworks remake-assets {名前} --style-from {参照} --vibe-info-extracted 0.8
animaworks remake-assets {名前} --style-from {参照} --seed 42
animaworks remake-assets {名前} --style-from {参照} --image-style anime|realistic
animaworks remake-assets {名前} --style-from {参照} --dry-run
animaworks remake-assets {名前} --style-from {参照} --no-backup
外部ツール実行(animaworks-tool)
Anima が外部サービス(Slack, Gmail, GitHub 等)を使う場合のコマンド。
第1引数が登録済みツール名または submit のとき、animaworks は内部で animaworks-tool に振り替わる(例: animaworks web_search query "...")。
animaworks-tool {ツール名} --help
animaworks-tool {ツール名} {サブコマンド} [引数...]
animaworks-tool submit {ツール名} {サブコマンド} [引数...]
具体例
animaworks-tool web_search query "AnimaWorks framework"
animaworks slack send --channel "#general" --text "おはようございます"
animaworks-tool github issues --repo owner/repo
animaworks-tool submit image_gen pipeline "1girl, ..." --anima-dir $ANIMAWORKS_ANIMA_DIR
submit の詳細 → common_knowledge/operations/background-tasks.md
ディレクトリの整理
state/background_tasks/ — submit 由来の非同期タスク記述子(pending / done 等)。internal list-background-tasks / check-background-task はここを読む。
state/background_notifications/ — ツール完了通知などを heartbeat が吸い上げる用途(MCP・スケジューラ等が書き込む経路あり)。CLI の list-background-tasks とは別。
子プロセス向けサブコマンド(internal / vault / supervisor)
いずれも ANIMAWORKS_ANIMA_DIR 必須(task と同じ)。トップレベル animaworks にも同名サブコマンドが登録されている。
internal
animaworks-tool internal archive-memory {相対パス}
animaworks-tool internal check-permissions {ツール名} [アクション]
animaworks-tool internal create-skill {名前} [--content ...]
animaworks-tool internal manage-channel create|archive {チャネル名}
animaworks-tool internal list-background-tasks
animaworks-tool internal check-background-task {task_id}
vault(Anima 名前空間付き KV)
animaworks-tool vault get {キー}
animaworks-tool vault store {キー} {値}
animaworks-tool vault list
supervisor(ANIMAWORKS_ANIMA_DIR の Anima 名を起点に、status.json の supervisor 関係で配下を解決)
animaworks-tool supervisor org-dashboard
animaworks-tool supervisor ping [--name {部下名}]
animaworks-tool supervisor read-state {部下名}
animaworks-tool supervisor task-tracker [--status delegated]
バックグラウンドタスクの確認
- 会話中: MCP ツール
list_background_tasks / check_background_task
- CLI:
animaworks-tool internal list-background-tasks / check-background-task {task_id}(ANIMAWORKS_ANIMA_DIR 設定下、state/background_tasks/)
初期化・マイグレーション
animaworks init
animaworks init --force
animaworks init --skip-anima
animaworks init --template {名前}
animaworks init --from-md {PATH}
animaworks init --blank {名前}
animaworks init --from-md {PATH} --name {名前}
animaworks migrate-cron
スキーマ移行・DB再同期は animaworks migrate(上記)を参照。
グローバルオプション
animaworks --gateway-url http://host:port {コマンド}
animaworks --data-dir /path/to/data {コマンド}
--data-dir はサブコマンド実行前に ANIMAWORKS_DATA_DIR へ反映される。