Star8 CLI リファレンス — ドメイン管理

Star8 CLI で、保有ドメインの情報取得、ネームサーバー・DNS・Whois設定、取得・移管・契約更新を行うためのリファレンスです。

star8 domain 配下のコマンドを掲載しています。レンタルサーバーへ追加するドメイン設定やサーバー側DNSではなく、ドメインレジストラで保有・管理するドメインが対象です。

CLIの変更履歴は 更新履歴 を参照してください。

インストール

Node.js（v18 以上）がインストールされた環境で、npm からグローバルインストールしてください。

npm install -g star8-cli

インストール後は、ターミナルのどのディレクトリからでも star8 コマンドが利用可能です。

インストールせずに即時実行することもできます。

npx star8-cli domain list

バージョン確認

star8 --version

認証設定

APIを利用するには、事前にAPIキーを設定する必要があります。APIキーはStar8アカウント画面の「APIキー管理」から発行できます。

APIキーの発行手順については、下記マニュアルをご参照ください。

• スターレンタルサーバー — API設定マニュアル

star8 auth login

対話形式でAPIキーを設定します。APIキーの入力はセキュリティのためマスク表示（***）され、ログイン時に利用可能なサービス・権限・操作対象・APIキー有効期限を表示します。ドメインサービスでは、ドメインの取得・移管・更新が許可されているかも確認できます。ドメイン管理コマンドではサーバー名の指定は不要です。

star8 auth login
# ✔ APIキーを入力: ****
# 認証情報を検証中...
# ✓ 認証に成功しました
#
# 利用可能なサービス:
#   Domain
#     権限: すべての操作
#     対象ドメイン:
#       - example.com
#     取得・移管・更新: 許可されていません
#
# APIキー有効期限: 2026-12-31 00:00:00
#
# ✓ プロファイル "default" を保存しました
#   設定ファイル: ~/.config/star8-cli/config.json

オプションで非対話的に設定することも可能です（CI/CD 環境向け）。

star8 auth login --api-key YOUR_API_KEY

プロファイル

複数のAPIキーを名前付きプロファイルとして保存し、切り替えて使うことができます。

star8 auth login --profile staging

star8 --profile staging domain list

star8 auth profiles

star8 --format json auth profiles

設定ファイルは ~/.config/star8-cli/config.json に保存されます。

環境変数

環境変数でもAPIキーを指定できます。CI/CD パイプラインでの利用に適しています。

STAR8_API_KEY=YOUR_API_KEY star8 domain list

認証の優先順位

※環境変数はSTAR8_API_KEYが設定されている場合のみ使用されます。

star8 auth status

現在の認証状態を確認します。

star8 auth status

star8 --format json auth status

グローバルオプション

すべてのコマンドで共通して利用できるオプションです。

domain コマンドの対象

star8 domain 配下では、各コマンドの引数で対象ドメインを指定します。--servernameやSTAR8_SERVERNAMEは使用しません。

出力形式

テーブル形式（デフォルト）

人間が読みやすい形式で出力します。

star8 domain list

JSON形式

プログラムからの利用やパイプラインでの処理に適した形式です。jq コマンドと組み合わせて使うこともできます。

課金操作では、見積内容や確認メッセージを標準エラー出力へ、最終結果を標準出力へ表示します。--format json の標準出力はそのままパイプ処理できます。

star8 --format json domain list

star8 --format json domain list | jq ".domains[].domain_name"

課金操作の安全確認

domain register、domain transfer、domain renewは、実申込の前に見積内容と税込金額を表示します。試算のみ行う場合は --dry-run を指定してください。

• domain check、domain pricing、domain register、domain transfer、domain renewの利用には、APIキー管理画面で「このキーでドメインの新規取得・移管・更新（お申し込み）を許可する」を有効にしておく必要があります。
• 税込価格は、事前にdomain checkまたはdomain pricingで確認してください。取得・更新では1年あたりの価格に年数を掛けた合計金額、移管では移管料金を使用します。
• --expected-total-priceには事前確認した税込合計金額を指定します。見積金額と一致しない場合はエラーとなり、実申込へ進みません。
• --dry-runを指定すると、見積表示だけで終了し、課金や申込は行いません。
• 実申込には--confirm-purchaseが必要です。汎用の--yesでは省略できません。
• 実申込は対話式ターミナル（TTY）で、確認文字列（例: example.com を税込1721円で承認）を正確に入力した場合のみ実行されます。CIなどの非対話環境では実申込できません。
• 新規取得と移管では、 サービス利用規約および 個人情報の取り扱いについて を確認し、--agree-to-termsで両方へ明示的に同意する必要があります。
• --idempotency-keyを省略した場合は自動生成されます。入力不備・残高不足・価格不一致などで却下された場合は、最初に表示された同じキーで再実行できます。
• 通信エラーなどで結果が不明な場合は、同じキーで再実行すると重複申込を防げます。既に処理済みの場合は重複エラーになります。domain showと請求履歴で状態を確認し、未実行と確認できたときのみ新しいキーで再申請してください。

レート制限エラー

APIの利用上限を超えた場合、CLIはレート制限エラーを表示して終了します。待機時間が表示された場合は、その時間を目安に待ってから再実行してください。

認証失敗が短時間に続いた場合も、一時的にアクセスが制限されることがあります。APIキーや環境変数の設定を確認してから再試行してください。