tapcart-project

Tapcart プロジェクト

Tapcart CLI プロジェクト全体の操作です。すべてのコマンドは、Tapcart プロジェクトディレクトリのルートから実行します。

特に記載がない限り、すべてのコマンドはエージェントが直接実行します。

---

初回セットアップ

以下の手順を順番に進めて、ユーザーのローカル環境を何もない状態から使用可能な状態にします。

ステップ 1 — Node.js を確認する

node --version

Node 23 以降が必要です。インストールされていない、または古いバージョンの場合は、https://nodejs.org からインストールするようユーザーに伝えてください（最新の LTS ≥ 23）。Node.js はシステムに一度だけインストールすればよい前提条件です。インストール済みであることをユーザーが確認するまで、次に進まないでください。

ステップ 2 — Tapcart CLI をグローバルにインストールする

npm install -g @tapcart/tapcart-cli

インストールされたことを確認します。

tapcart --version

ステップ 3 — App ID を取得する

ユーザーに Tapcart App ID を尋ねてください。以下で確認できます。 https://app.tapcart.com/settings → Tapcart CLI API Key セクション

ステップ 4 — プロジェクトを作成する（既存の場合はスキップ）

現在のディレクトリに tapcart.config.json がすでにあるか確認してください。ある場合は、ステップ 5 に進みます。

プロジェクトがない場合は、新規作成します。

npm init @tapcart/tapcart-app@latest -- -a <app-id> -f <folder-name>
cd <folder-name>
npm install

ステップ 5 — 認証する

次のコマンドを実行します。ブラウザーウィンドウが自動的に開き、ユーザーが OAuth ログインを完了するまで処理が停止します。

tapcart auth login

コマンドが終了したら、認証は完了です。次のステップに進みます。

ステップ 6 — 既存のブロックとコンポーネントをプルする

tapcart block pull -a
tapcart component pull -a

これでプロジェクトを使用する準備が整いました。

---

認証

# Log in (opens browser automatically, blocks until complete)
tapcart auth login

# Log out
tapcart auth logout

認証情報はローカルに保存され、セッションをまたいで保持されます。

---

依存関係

依存関係は、ブロック内でインポートできる npm パッケージです。使用するには、ローカルに追加してからリモートのアプリ設定にプッシュする必要があります。

# Add a dependency
tapcart dependency add lodash 4.17.21

# Remove a dependency
tapcart dependency remove lodash

# List local dependencies
tapcart dependency list

# Pull dependencies from remote app config
tapcart dependency pull

# Push local dependency list to remote app config
tapcart dependency push

依存関係を追加した後、該当するブロックの config.json の "dependencies": [] にパッケージ名を追加し、その後 tapcart dependency push を実行するようユーザーに伝えてください。

---

リント

リントを実行し、出力をユーザーに表示します。

# Lint all blocks and components
tapcart lint --all

# Lint specific blocks
tapcart lint -b MyBlock -b AnotherBlock

# Lint specific components
tapcart lint -c ProductCard

# Lint with auto-fix (writes changes to disk)
tapcart lint --all --fix
tapcart lint -b MyBlock --fix

リントの出力をユーザーに表示し、--fix を付けて実行する前に確認してください。

---

ログ

tapcart log

---

レイアウト開発サーバー

レイアウト開発サーバーをバックグラウンドで実行し、起動中であることをユーザーに伝えてください。ユーザーから停止を依頼されるまで、実行し続けます。

# Prompts interactively for layout type if not provided
tapcart layout dev

# Specify layout type
tapcart layout dev -l home

# Specify layout type and a particular layout ID
tapcart layout dev -l home -v <layoutId>

# Override specific blocks with their local version
tapcart layout dev -l home -b MyBlock -b AnotherBlock

# Override all blocks with local versions
tapcart layout dev -l home -a

# Custom port (default is 4995)
tapcart layout dev -l home -p 4995

デフォルトでは、開発サーバーはダッシュボードのライブバージョンを使ってブロックをレンダリングします。ローカルのブロックを使うには -b <BlockFolderName> を、すべてのローカルブロックを使うには -a を指定してください。

ユーザーから開発サーバーの停止を依頼されたら、プロセスを終了してください。