カラーミーショップ CLI

カラーミーショップの運営作業を、ターミナルやAIエージェントから操作できる開発者向けツールです。

Claude CodeやGemini CLIなどと組み合わせることで、複数の操作をまとめて実行するといった高度な使い方にも対応しています。

はじめに

このガイドでは、CLI のインストールから最初のコマンド実行までを 3 ステップで説明します。

ステップ 1: インストール

Node.js（v20 以上）をインストールしてから、ターミナルで以下を実行します。

npm install -g @colorme/cli

バージョンが表示されればインストール完了です。

colorme --version
# => 1.0.0

ステップ 2: OAuth アプリの登録

CLI がカラーミーショップの API にアクセスするために、OAuth アプリの登録が必要です。

1. カラーミーショップ デベロッパー にアクセス
2. 「アプリケーションを登録」をクリック
3. リダイレクト URI に http://127.0.0.1/callback を入力して登録

登録後に表示される Client ID と Client Secret を、環境変数に設定します。

Bash / Zsh:

export COLORME_CLIENT_ID="ここにClient IDを貼り付け"
export COLORME_CLIENT_SECRET="ここにClient Secretを貼り付け"

~/.bashrc や ~/.zshrc に追加しておくと毎回設定する必要がなくなります。

PowerShell:

$env:COLORME_CLIENT_ID="ここにClient IDを貼り付け"
$env:COLORME_CLIENT_SECRET="ここにClient Secretを貼り付け"

$PROFILE に追加しておくと毎回設定する必要がなくなります。

ステップ 3: ログインとスキルのインストール

以下のコマンドを実行すると、ブラウザが開いてカラーミーショップの認証画面が表示されます。ログインして「許可」すると、認証と AI Agent Skills のインストールが行われます。

colorme setup

正しくログインできたことを確認するには：

colorme status

ショップ名や認証状態が表示されれば準備完了です。

使ってみよう

ログインが終わったら、さっそく CLI を使ってみましょう。

商品情報を取得する

# 商品一覧を 5 件取得
colorme api "/v1/products" --query 'limit=5'

# jq と組み合わせて商品名だけ取り出す
colorme api "/v1/products" | jq '.products[].name'

静的ファイルをアップロードする

FTP 経由で HTML や画像などの静的コンテンツをホストできます。

# FTP にログイン
colorme ftp login

# ファイルの一覧を確認
colorme ftp ls /

# ファイルをダウンロード
colorme ftp get /index.html -

# ファイルをアップロード
colorme ftp put ./index.html /index.html

テンプレートを編集する

テンプレートの HTML/CSS をローカルにダウンロードし、編集してアップロードできます。

# テンプレート一覧を確認
colorme template list

# 作業ディレクトリを作成して移動
mkdir my-theme && cd my-theme

# テンプレートをダウンロード（カレントディレクトリに展開される。初回は --template-id 必須）
colorme template pull --template-id 1

# ファイルを編集して push
colorme template push

# プレビューをブラウザで確認
colorme template preview --open

ヘルプ記事を検索する

カラーミーショップのヘルプセンターから記事を検索できます。認証不要です。

colorme docs search "配送設定"

コマンド一覧

| コマンド | 説明 | |---------|------| | colorme setup | 初期セットアップ（認証 + スキルインストール） | | colorme login | OAuth 認証 | | colorme logout | ログアウト（全認証情報を削除） | | colorme status | 認証状態・ショップ情報・FTP 接続状態を表示 | | colorme api | カラーミーショップ API の呼び出し | | colorme template | テンプレート HTML/CSS をダウンロードしてローカルで編集・アップロード | | colorme ftp | FTP によるファイル操作 | | colorme docs | ヘルプ記事・ドキュメント検索 | | colorme skill | AI Agent Skills のインストール・管理 | | colorme completion | シェル補完スクリプトの出力 |

各コマンドの詳細は colorme <command> --help で確認できます。

もっと詳しく

API

HTTP メソッド + パスでカラーミーショップ API を呼び出します。

# 商品一覧
colorme api "/v1/products" --query 'limit=5&offset=0'

# 商品を更新
colorme api "/v1/products/123" -X PUT --data '{"product":{"name":"新商品名"}}'

# JSON ファイルからデータを送信
cat product.json | colorme api "/v1/products" -X POST --stdin

# API エンドポイントのドキュメントを表示
colorme api-docs "/v1/products"

テンプレート

テンプレートの HTML/CSS をローカルで管理できます。pull 時に生成される colorme-template.json でテンプレート ID を管理します。

# テンプレート一覧
colorme template list

# 作業ディレクトリを作成して移動
mkdir my-theme && cd my-theme

# ダウンロード（カレントディレクトリに展開される。初回は --template-id 必須、以降は colorme-template.json から自動取得）
colorme template pull --template-id 1

# 編集後にアップロード
colorme template push

# プレビュー URL を取得（--open でブラウザを開く）
colorme template preview --open

FTP

ファイルの取得・アップロード・同期・削除ができます。

# ローカルのフォルダと同期
colorme ftp sync ./my-site/ /

# stdin からアップロード
echo '<h1>Hello</h1>' | colorme ftp put - /index.html

# ファイルを削除
colorme ftp delete /old.html --yes

ドキュメント検索

colorme docs search "配送設定"
colorme docs get 12345
colorme docs list --limit 10

AI Agent Skills

CLI にバンドルされた Skills（スキル） をインストールすると、Claude Code などの AI エージェントがカラーミーショップの API・FTP・ヘルプ記事検索を操作できるようになります。

# スキル一覧を確認
colorme skill list

# スキルをインストール（デフォルト: ~/.claude/skills/）
colorme skill install

# インストール状態を確認
colorme skill status

# スキルをアンインストール
colorme skill uninstall

環境変数

| 変数名 | 説明 | デフォルト | |--------|------|-----------| | COLORME_CLIENT_ID | OAuth Client ID（必須） | - | | COLORME_CLIENT_SECRET | OAuth Client Secret（必須） | - | | COLORME_SKILLS_DIR | スキルのインストール先 | ~/.claude/skills | | XDG_CONFIG_HOME | 設定ファイルの基底ディレクトリ | ~/.config | | XDG_DATA_HOME | データファイルの基底ディレクトリ | ~/.local/share |