docyrus-cli-app

Docyrus CLI

docyrus CLI（@docyrus/docyrus）のコマンド一覧です。このスキルは、どのようなコマンドがあるかを確認するためのクイックリファレンスです。各コマンドの正確なフラグ、引数、ペイロードの形式を確認するには、ヘルプを実行してください。ヘルプは常に最新の信頼できる情報源です。

docyrus <command> --help                 # flags + args for a command or group
docyrus <command> <subcommand> --help     # drill into a subcommand
docyrus <command> --llms                  # machine-readable (LLM) manifest of a command tree

規約（すべてのコマンドに適用）

• 出力： 機械可読な出力にするには、--json（または --format <toon|json|yaml|md|jsonl>）を追加します。--verbose を指定すると、エンベロープ全体が表示されます。
• フラグの形式： --help では、フラグがケバブケース（--app-slug、--from-file）で表示されます。パーサーはキャメルケースのスキーマキー（--appSlug、--fromFile）も受け付けます。どちらも使用できます。
• セレクターは排他的なペアです — 各ペアから必ず1つだけ指定します。CLI がもう一方を解決します：--appId | --appSlug、--dataSourceId | --dataSourceSlug、--fieldId | --fieldSlug など。
• 書き込みペイロード： 変更を行うコマンドでは、利便性の高いフラグと --data '<json>'、または --from-file <path.json> を使用できます。明示的なフラグは JSON の値に優先して適用されます。複雑なオブジェクト（ネストされた data、field_mapping、スキーマ、条件）は --data または --from-file で指定する必要があります。
• 設定のスコープとセッション： 設定はプロジェクトローカルの ./.docyrus/ フォルダーに保存されます（cwd から親ディレクトリをたどって解決されます）。-g／--global を指定すると ~/.docyrus/ が使用されます。認証とアクティブなテナントはスコープごとに設定されます。
• エスケープハッチ： docyrus curl <path> [-X .. -d .. -G] を使うと、認証済みリクエストを任意の API パスに送信できます。専用コマンドがないエンドポイント（例：テンプレートのレンダリング、ウェブフォームのアイテム）で使用してください。複雑な読み取りでは、クエリパラメーターを1つの JSON オブジェクトとして -G -d '{...}' で渡します（URL エンコードは自動的に行われます）。

コマンド一覧

フラグを確認するには、docyrus <command> --help を実行してください。**（グループ）**と記されたグループには独自のサブコマンドがあります。--help を使って詳細を確認してください。

auth — 認証、アカウント、テナント

login · logout · who · tenant · set-tokens · sso-session · github · sandbox · git-credential · accounts（グループ） · tenants（グループ）

apps — アプリとアプリスコープのリソース

create（--slug が必要） · clone · templates · check-slug（アプリの作成とローカル開発の初期設定 — docyrus-create-app を参照） · list · update · delete · restore · permanent-delete · set-agent-context · actions（グループ：アクションの CRUD と実行） · ai-tools（グループ：アプリスコープの AI ツールの CRUD — docyrus-app-ai-tools を参照）

ds — データレコード（CRUD とサブオブジェクト）

get（データソースのメタデータ） · list（レコードのクエリ） · create · update · delete · comments（グループ：レコードのコメント） · files（グループ：レコードのファイル添付。upload を含む）

dsql — 論理 SQL クエリ

query（appSlug.dataSourceSlug に対する読み取り専用の SELECT） · ask（自然言語 → クエリ → 実行） · generate（自然言語 → クエリ。実行なし） · schema（グループ：スキーマの検出）。docyrus-dsql-query-design を参照。 カスタムクエリレコード（保存済みのパラメーター化されたクエリテンプレート）：list-custom-query · get-custom-query · create-custom-query · update-custom-query · delete-custom-query · run-custom-query（実行。--debug = コンパイル済み SQL、--simulate = EXPLAIN ANALYZE）。docyrus-custom-query を参照。

studio — 開発アプリのスキーマ CRUD

データソース：create-data-source · get-data-source · update-data-source · delete-data-source · restore-data-source · permanent-delete-data-source · list-data-sources · bulk-create-data-sources フィールド：create-field · get-field · update-field · delete-field · list-fields · create-fields-batch · update-fields-batch · delete-fields-batch · search-fields 列挙型：create-enums · update-enums · delete-enums · list-enums · search-enums · search-enum-sets データビュー：create-data-view · get-data-view · update-data-view · delete-data-view · list-data-views フォーム：create-form · get-form · update-form · delete-form · list-forms Webフォーム：create-webform · get-webform · update-webform · delete-webform · list-webforms（docyrus-webform-design を参照） HTML/PDF テンプレート：create-html-template · get-html-template · update-html-template · delete-html-template · list-html-templates（docyrus-print-pdf-template-design を参照） メールテンプレート：create-email-template · get-email-template · update-email-template · delete-email-template · list-email-templates（docyrus-email-template-design を参照） → 設計ガイド：docyrus-data-source-design。

automation — ワークフロー

自動化：create · get · update · delete · list トリガー：create-trigger · update-trigger · delete-trigger · get-trigger · list-triggers アクションノード：create-node · update-node · delete-node · get-node · list-nodes → 設計ガイド：docyrus-automation-design。

agent — カスタム AI エージェントとサブリソース

エージェント：create · get · update · delete · list · upload サブリソースグループ（それぞれ list/get/create/update/delete）：models · tools · data-sources · docs · mcps · connections · dynamic-contexts · workflow-steps · deployments · deployment-tools · deployment-data-sources · workflow-jobs（読み取り専用＋削除）· tasks · recurring-tasks → 設計ガイド：docyrus-agent-design。

messaging — メールと通知

accounts（テナントのメールアカウントを一覧表示）· email（グループ：send を含む）

account — テナントアカウント管理

brands（グループ：テナントブランドの CRUD — list · get · create · update · delete · fetch-from-website）· user-profile（グループ：現在のユーザー自身のプロフィールを get · update）· tenant-preferences（グループ：テナントの地域／書式設定を get · update）

• brands — テナントのビジュアルアイデンティティ、タイポグラフィ、ブランドの声、コンテンツガイドライン（tenant_brand）。create／update は camelCase の便利なフラグ（snake_case の DTO キーと 1 対 1 に対応）と --data／--from-file を受け取ります。create では --name が必須です。→ 管理ガイド（全フィールド一覧を含む）：docyrus-tenant-brand-management。
• user-profile — 認証済みユーザー自身のプロフィール（get／update、セレクターなし）。update のフラグはセルフサービス項目を対象としています：--firstname · --lastname · --mobile · --dateOfBirth · --gender · --timeZone · --language。
• tenant-preferences — ワークスペースの地域／書式設定。update はテナント管理者のみ実行でき、camelCase のフラグ（snake_case の --data キーと 1 対 1 に対応）と --data／--from-file を受け取ります：--language · --locale · --timeZone · --startWeekOn · --fiscalYear · --dateFormat · --dateTimeFormat · --timeFormat · --longDateFormat · --businessHoursBegin · --businessHoursEnd · --dailyWorkingHours（秒）· --weeklyWorkingCapacity · --timeRounding · --baseCurrency · --currencyAbbrPosition（BEFORE／AFTER）· --decimalPrecision · --decimalSeparator · --thousandSeparator。get は設定レコードのみを返します（camelCase キー）。

→ user-profile／tenant-preferences のガイド（全フィールド一覧を含む）：docyrus-account-settings。

connect — コネクターとアクション

list-connectors · get-connector · list-connections · get-action · run-action · curl（コネクターのプロバイダー認証を通じたリクエスト） → 使用方法：docyrus-integrations-and-connectors。

discover — テナントの OpenAPI 検出

api（仕様をダウンロード） · namespaces · path · endpoint · entity · search

curl — 生の API

docyrus curl <path> [-X <method>] [-d <body>] [-G] [-H <header>] — 任意の Docyrus API パスへの認証済みリクエストです。

• 本文： docyrus curl -X POST /v1/apps -d '{"name":"..."}' — JSON の -d はリクエスト本文として送信されます。
• クエリパラメーター： -G を指定する場合、-d には単一の JSON オブジェクトを渡します。各キーはクエリパラメーターになり、ネストされた値は JSON 文字列化され、すべての値は自動的に URL エンコードされます。エスケープせずに複雑な読み取り（columns、filters、childQueries）を送信するには、この方法を使います。 docyrus curl "/v1/apps/<app>/data-sources/<ds>/items/<id>" -G -d '{"columns":"id,rel(id,name),app_child__ref","childQueries":[{"alias":"app_child__ref","from":"app_child","using":"ref","columns":"name"}]}'
• -d に指定できる値は1つだけ（複数回指定不可）で、--data-urlencode はありません。上記の -G と JSON オブジェクトを組み合わせる方法で、どちらも代替できます。

AI エージェントとランタイム

docy "<prompt>"（プラットフォームのメイン AI エージェントとチャット） · worky（pi Cowork エージェント） · cody / coder（pi Coding エージェント） · server（pi エージェントから AI SDK useChat への HTTP ブリッジ）

browser — ブラウザー自動化（ローカルの Chrome またはリモートの Cloudflare）

start · url · nav · snapshot · click · fill · select · eval · run-script · screenshot · content · console · network · cookies · devtools · info · tabs · wait · close

knowledge — リポジトリのナレッジグラフ（開発ツール）

search · section · locate · refs · expand · check · doctor · audit-staged · pre-commit · list-impacted · init · generate-initial · refresh · config · hook

project-plan — リポジトリで管理するプロジェクト計画（開発ツール）

show · summary · list-phases · list-features · list-tasks · find-tasks · get-task · upsert-phase · upsert-feature · upsert-task · set-task-status · set-order · ensure · check · config · create-linked-todo · upsert-from-architect · upsert-from-plan

release — バージョン管理

new-version · status

tui — ターミナル UI

docyrus tui — OpenTUI ターミナル UI を起動します（Bun が必要です。Bun がない場合は、対話型ターミナルでのインストールを提案します）。

組み込み機能

docyrus completions（シェル補完） · docyrus mcp add（MCP サーバーとして登録） · docyrus skills add（スキルファイルを同期） · グローバルオプション --mcp（MCP stdio サーバーとして起動）。

関連スキル

アプリの作成とローカル開発の初期設定（docyrus apps create / clone / templates）には、docyrus-create-app を使用します。これらのコマンドで管理するものを設計するには、専用スキルを使用します：docyrus-data-source-design、docyrus-automation-design、docyrus-agent-design、docyrus-app-ai-tools、docyrus-email-template-design、docyrus-print-pdf-template-design、docyrus-webform-design、docyrus-acl-design（docyrus acl）、docyrus-tenant-brand-management（docyrus account brands）、docyrus-account-settings（docyrus account user-profile / tenant-preferences）、docyrus-dsql-query-design、docyrus-custom-query（docyrus dsql *-custom-query による保存済みクエリレコード）。プラットフォームのアーキテクチャ／概念については、docyrus-platform を使用します。アプリコードで REST API を使う場合は、docyrus-api-dev を使用します。