English documentation follows in the second half of this page. Jump to English.
intra-mart Accel Platform (iAP) 開発プロジェクトの作成・管理を行う CLI ツール @intra-mart/accel の GUI 体験を提供する VS Code 拡張。
CLI の対話フローと同等の操作を、サイドバーとフォーム画面から実行できます。CLI 本体は拡張に同梱されるため、別途インストールは不要です。
機能
アクティビティバーの Accel アイコンからサイドバーを開き、各コマンドを実行します。init / update / switch / deploy はフォーム画面(webview タブ)が開き、CLI の対話内容と同じ項目を入力・選択して実行できます(build はフォームなしでターミナル実行)。
| コマンド |
内容 |
| プロジェクトを初期化 (init) |
新規プロジェクトを作成し、資材を配備 |
| 資材を更新 (update) |
配備済みの資材を資材リポジトリの最新版へ更新 |
| 構成を切り替え (switch) |
モジュール・機能・エージェント構成をダウンロードなしで切り替え |
| デプロイ (deploy) |
ビルド成果物を iAP のステージング環境へデプロイ |
| ビルド (build) |
プロジェクト設定のパッケージマネージャで run build を実行 |
- 入力値は CLI と同じバリデーションが入力欄の下にリアルタイム表示されます
- update / switch のフォームでは、登録済みの構成プリセット(
accel preset で作成)を選択して、モジュール・機能・エージェントをまとめて切り替えられます。プリセット選択中は3項目の個別選択が無効になり、実行前の確認画面にプリセットの適用内容が表示されます。プリセットの内容が対象の iAP バージョンに存在しない場合は、選択した時点でエラーが表示されます(プリセットの作成・削除は CLI の accel preset で行います)
- iAP の接続情報は deploy フォームで入力します。エンドポイントは前回値が表示され、API キーは保存済みの有無のみ表示されます(実値は画面に出しません。空欄のままなら保存済みのキーを使用)。「接続テスト」で保存前に有効性を確認できます
- テナント環境セットアップ / サンプルデータセットアップは、deploy のフォームで実行有無を事前に選択します(一括実行のみ。実行する設定ファイルを選ぶ個別実行は CLI の対話モードをご利用ください)
- デプロイ成功後は、ステージング詳細画面へのショートカット URL(自動ログイン付き)が結果画面にリンク表示され、クリックでブラウザから開けます
- 実行中の進捗・ログはフォーム画面と出力チャネルの両方に表示されます。タブを閉じても実行は継続し、再表示時に現在の状態へ復帰します
- 未初期化のワークスペースでは、サイドバーに「プロジェクトを初期化」の案内が表示されます
必要環境
- Visual Studio Code 1.127.0 以上(デスクトップ版のみ。vscode.dev などのブラウザ版は非対応)
- プロジェクトのビルド・依存インストールに使うパッケージマネージャ(Bun / npm / Yarn / pnpm のいずれか)
インストール
配布方式は確定後にここへ記載します。それまでは docs/development.md の手順でビルドした VSIX をインストールしてください。
対応言語
日本語 / English / 简体中文(VS Code の表示言語設定に追従します)
ドキュメント
docs/architecture.md — 拡張の技術構成・設計
docs/development.md — 開発手順(ビルド・テスト・パッケージング)
English
A VS Code extension that gives a GUI to @intra-mart/accel,
the CLI tool for creating and managing intra-mart Accel Platform (iAP) development projects.
Everything the CLI offers through its interactive prompts is available from a sidebar and
form screens. The CLI itself ships with the extension, so you do not install it separately.
Features
Open the sidebar from the Accel icon in the Activity Bar and run a command from there.
init, update, switch, and deploy open a form screen as a webview tab, where you fill in the
same items the CLI asks for. build runs in a terminal without a form.
| Command |
What it does |
| Initialize project (init) |
Create a project and place its resources |
| Update resources (update) |
Update placed resources to the latest version in the resource repository |
| Switch configuration (switch) |
Switch the module, feature, and agent configuration without downloading |
| Deploy (deploy) |
Deploy build output to an iAP staging environment |
| Build (build) |
Run run build with the package manager configured for the project |
- Input is validated exactly as the CLI validates it, and the result appears under the field as you type
- The update and switch forms let you pick a saved configuration preset, created with
accel preset, and switch modules, features, and agents together. Selecting a preset disables the three individual selectors, and the confirmation screen shows what the preset applies. If the preset refers to something the target iAP version does not have, the error appears the moment you select it. Presets themselves are created and deleted with the accel preset CLI command
- iAP connection details are entered in the deploy form. The endpoint is prefilled with the previous value. For the API key, only whether one is stored is shown, never the value itself, and leaving the field empty reuses the stored key. Use Test connection to check the details before saving
- Tenant environment setup and sample data setup are chosen in the deploy form before the run. Only the all-at-once form is supported here. To pick individual configuration files, use the CLI in interactive mode
- After a successful deploy, the result screen links to a shortcut URL for the staging detail page, with automatic sign-in, so you can open it in a browser with one click
- Progress and logs appear both in the form screen and in the output channel. Closing the tab does not stop the run, and reopening it returns to the current state
- In a workspace that has not been initialized yet, the sidebar shows guidance for initializing a project
Requirements
- Visual Studio Code 1.127.0 or later. Desktop only. Browser builds such as vscode.dev are not supported
- A package manager for building the project and installing its dependencies. Bun, npm, Yarn, or pnpm
Installing
The distribution method will be documented here once it is decided. Until then, build a VSIX
by following docs/development.md and install that.
Language
日本語 / English / 简体中文. The extension follows the VS Code display language setting.
Documentation
docs/architecture.md — technical structure and design of the extension
docs/development.md — development steps for building, testing, and packaging