開発 · コマンドリファレンス
qzx deployProject
機能
明示した成果物を SSH 経由でプレビューまたはデプロイし、検証済みリモートバックアップ、SHA-256 検証、アトミック昇格、ヘルスチェック、自動ロールバックを行います。
コマンドの成熟度: Alpha
実際の利用とフィードバックに使えますが、インターフェースと動作はまだ変更される可能性があります。 これは現在の開発チェックアウトに対する評価です。今後の各不変リリースタグには、そのバージョンに含まれた正確な評価が保存されます。 PyPI 0.2.2.0.9 で利用できます。ドキュメントは alpha チェックアウト 0.2.2.0.9 に対応しています。
動作と組み込み保護
実行モードでは指定した変更を適用します
プレビュー利用可能
必要に応じてネイティブツールを使用します
文書化されたタスクのためにネットワークを使用します
現在の権限を使用します。結果は変わる可能性があります
既定モードはプレビューのみで接続しません。実デプロイには、通常の OpenSSH ファイルまたは明示的な known_hosts による既知の SSH 識別情報が必要です。まずローカル成果物とリモート状態をバックアップし、新規ディレクトリへアップロードし、各ファイルを SHA-256 で検証し、同一ファイルシステム内で昇格し、URL に秘密情報を含まない HTTP(S) チェックを必須とします。失敗した場合は以前のリモート状態を自動復元します。QZX はビルドせず、rsync --delete を使わず、権限を変更せず、任意のリモートコマンドを実行せず、サービスを再起動しません。返されたバックアップ/復旧パスも自動削除しません。
QZX は実際の変更前に復旧用ファイルを作成します。意図的に省略すると決めた場合にのみ --dangerously-bypass-approvals-and-sandbox/--yolo を使用してください。
文書化された外部サービスを使用し、以下に記載されたデータだけを共有します。
この安全分類は 2026-08-25 に OpenAI GPT-5.6 Pro が実装ダイジェスト sha256:240e73f477e23633addd75a0fcc9da0ec756665594164338a747bec91d09d58d と照合してレビューしました。
正確な構文
qzx deployProject <target_host> [path] <target_path> [port] [ssh_key] [known_hosts] [health_url] [health_expect] [health_attempts] [health_interval] [health_timeout] [deployment_id] [dry_run] --jsonパラメータ
スワイプするか横スクロールバーを使って、すべての列を表示してください。
| 名前 | 型 | 必須 | 既定値 | 説明 |
|---|---|---|---|---|
| target_host | str | はい | 未宣言 | host または ユーザー@host 形式の SSH 宛先 |
| path | str | いいえ | "." | デプロイする成果物の明示的なローカルディレクトリ。QZX はビルドせず、プロジェクトルートへ置き換えることもありません |
| target_path | str | はい | 未宣言 | アクティブバージョンになる絶対リモートディレクトリ |
| port | int | いいえ | 22 | SSH ポート |
| ssh_key | str | いいえ | 未宣言 | 任意のローカル SSH 秘密鍵ファイル |
| known_hosts | str | いいえ | 未宣言 | リモートサーバーの識別確認に使う、明示指定可能な任意の OpenSSH known_hosts ファイル |
| health_url | str | いいえ | 未宣言 | 認証情報、query、fragment を含まない HTTP(S) endpoint。実デプロイでは必須で、昇格後に確認します |
| health_expect | str | いいえ | 未宣言 | ヘルス応答本文に含まれる必要がある任意のテキスト |
| health_attempts | int | いいえ | 5 | ヘルスチェック試行回数。1～20 |
| health_interval | float | いいえ | 2 | ヘルスチェック試行間隔の秒数。0～30 |
| health_timeout | float | いいえ | 5 | 各ヘルスチェックのタイムアウト。0.1～30 秒 |
| deployment_id | str | いいえ | 未宣言 | 監査・復旧パスに組み込む任意の安定識別子 |
| dry_run | bool | いいえ | true | 接続せずに正確な成果物とすべてのリモートパスをプレビュー |
入力例
qzx deployProject --target-host [email protected] --path ./dist --target-path /srv/example/current成果物を検査し、すべてのリモート復旧パスをプレビュー
qzx deployProject --target-host [email protected] --path ./dist --target-path /srv/example/current --health-url https://example.test/health --health-expect "ready" --dry-run false成果物をバックアップして検証済みデプロイを実行
完全な構造化ペイロードを取得するには --json を追加します: qzx deployProject <target_host> [path] <target_path> [port] [ssh_key] [known_hosts] [health_url] [health_expect] [health_attempts] [health_interval] [health_timeout] [deployment_id] [dry_run] --json
代表的な出力例
この説明用 JSON は現在の実装が裏付ける結果コントラクトから生成されています。記録された実行だと主張せず、コマンドが返し得る内容を示します。値は入力、マシン、権限、オプションツールによって変わります。
例のコマンド: qzx deployProject --target-host [email protected] --path ./dist --target-path /srv/example/current --json
{
"success": true,
"message": "Previews or deploys one explicit artifact over SSH using a verified remote backup, SHA-256 validation, atomic promotion, health checks, and automatic rollback. In this illustrative example, the command completed successfully.",
"meta": {
"command": "deployProject",
"command_maturity": {
"stage": "alpha",
"label": "Alpha",
"sequence": 2,
"public_executable": true,
"stability": "interface_may_change",
"summary": "Available for real use and feedback while its interface and behavior can still evolve.",
"promotion_review_required": false,
"assessment_scope": "development_checkout"
},
"duration_ms": 0,
"schema_version": 1
},
"details": {
"summary": "Additional structured context is included here."
}
}JSON 結果コントラクトを見る
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
"success",
"message",
"meta"
],
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"meta": {
"type": "object",
"required": [
"command",
"command_maturity",
"duration_ms",
"schema_version"
],
"properties": {
"command": {
"type": "string"
},
"command_maturity": {
"type": "object",
"required": [
"stage",
"label",
"sequence",
"public_executable",
"stability",
"summary",
"promotion_review_required",
"assessment_scope"
],
"properties": {
"stage": {
"type": "string"
},
"label": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"public_executable": {
"type": "boolean"
},
"stability": {
"type": "string"
},
"summary": {
"type": "string"
},
"promotion_review_required": {
"type": "boolean"
},
"assessment_scope": {
"type": "string"
},
"note": {
"type": "string"
},
"review": {
"type": "object",
"required": [
"reviewed_on",
"rationale",
"evidence"
],
"properties": {
"reviewed_on": {
"type": "string",
"format": "date"
},
"rationale": {
"type": "string"
},
"evidence": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
},
"replacement": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": true
},
"duration_ms": {
"type": "number"
},
"schema_version": {
"type": "integer"
}
},
"additionalProperties": true
},
"details": [],
"error": [],
"error_code": []
},
"additionalProperties": true
}エラーと制限
公開コントラクトでは失敗時に success=false と説明的な message が必要です。このカタログではまだコマンドごとのエラー分類を宣言していません。結果を確認し、存在しないコードを推測しないでください。
QZX は alpha 段階です。オプション依存関係、権限、ホスト機能によって結果が変わる場合があります。
証拠フロー: 承認済みエンドポイントまたはレビュー済み fixture が必要。
証拠と出所
- ドキュメントチャネル
- 開発ドキュメント 0.2.2.0.9 · main · sha256:cfba936e39931c286ca23add0ae546693db17d8b316e7cbc3891d26642d9b7e8
- 提供状況
- 0.2.2.0.9 以前
さらに探す
関連コマンド
これらのコマンドも 開発 カテゴリに属します。比較して、タスクに最適な操作を選んでください。