kamakiri status

kamakiri status は、クライアントのバージョン、使っている認証情報、紐付いているサイトとそのアドレスの状態を表示します。何も設定していないマシンでも答えが返ります。

使い方

kamakiri status [--verbose] [--recheck]

--verbose（または -v）は、対応が必要なものだけでなく、すべての独自ドメインについてDNSレコードを表示します。
--recheck は、ページを表示する前に、まだ配信されていない独自ドメインのDNSを確認するようサーバーに求めます。kamakiri domain の verify と同じ確認です。再確認には回数の制限があります。受け付けられなかった場合は最新の結果を表示し、コマンドは失敗しません。

表示の内容

認証情報がなくてもページは表示され、そのあとに理由が続きます。

$ kamakiri status
Version:      v0.3.0
Credentials:  (not found)
Logged in:    no
API server:   https://api.kamakiri-labs.jp/cloud
Site:         (none)
not logged in. Run "kamakiri login", or set KAMAKIRI_API_KEY to an API key

$ kamakiri status
バージョン:    v0.3.0
認証情報:      （見つかりません）
ログイン:      いいえ
APIサーバー:   https://api.kamakiri-labs.jp/cloud
サイト:        （なし）
ログインしていません。"kamakiri login" を実行するか、環境変数 KAMAKIRI_API_KEY にAPIキーを設定してください

KAMAKIRI_API_KEY にキーが入っている間は、「認証情報」にその変数の名前が出て、認証情報ファイルは読まれません。この変数にはメールアドレスが含まれないので、「ログイン」は「はい」になります。

$ kamakiri status
Version:      v0.3.0
Credentials:  KAMAKIRI_API_KEY (environment)
Logged in:    yes
API server:   https://api.kamakiri-labs.jp/cloud
Site:         (none)

$ kamakiri status
バージョン:    v0.3.0
認証情報:      KAMAKIRI_API_KEY（環境変数）
ログイン:      はい
APIサーバー:   https://api.kamakiri-labs.jp/cloud
サイト:        （なし）

kamakiri login のあとは、「認証情報」に認証情報ファイルのパスが、「ログイン」にキーを保存したときのアドレスが出ます。サイトに紐付いたディレクトリでは、「サイト」の行の代わりに、サイトのアドレスとプランに対する使用状況が出ます。

$ kamakiri status
Version:      v0.3.0
Credentials:  ~/.config/kamakiri/credentials.json
Logged in:    user@example.com
API server:   https://api.kamakiri-labs.jp/cloud
Subdomain:    my-site.kamakiri-pages.jp  ✓
Domain:       (none)
CDN:          none
Sites:        1 / 5
Snapshots:    0 / 5 (this site)
Max deploy:   100 MB

$ kamakiri status
バージョン:    v0.3.0
認証情報:      ~/.config/kamakiri/credentials.json
ログイン:      user@example.com
APIサーバー:   https://api.kamakiri-labs.jp/cloud
サブドメイン:  my-site.kamakiri-pages.jp  ✓
ドメイン:      （なし）
CDN:           none
サイト数:      1 / 5
保存デプロイ:  0 / 5（このサイト）
デプロイ上限:  100 MB

「サブドメイン」には、そのアドレスが設定どおりにサイトを配信し、最後の変更が完了していれば ✓ が付きます。
「ドメイン」には、正規ドメインが出ます。なければ「（なし）」です。
「サイト数」はアカウントのサイトの数、「保存デプロイ」はこのサイトに保持されているデプロイの数、「デプロイ上限」は1回のデプロイの大きさの上限です。

独自ドメイン

独自ドメインごとにブロックが続き、DNSとCDNの状態が出ます。対応が必要な行の下には、設定すべきDNSレコードも出ます。DNSの行は、⧗ DNSを待機中、⚠ DNSが別の宛先を指しています、⚠ DNSに到達できませんでした、⧗ このサイトにはまだ公開されたコンテンツがありません、⧗ エッジを確認中、⧗ SSL証明書を準備中、✓ 公開中 などの状態で始まります。それぞれの意味と対処は独自ドメインで説明しています。

デプロイの公開状況

訪問者にまだ前のデプロイが届く可能性がある間は、待機するコマンドが待っているのと同じ内容がページに出ます。Ctrl-C のあとや、別のマシンから確認するときに使えます。

⧗ 引き続き公開処理中 は、デプロイがまだ公開の途中であることを示します。
エッジキャッシュ: 引き続きクリア中（<経過時間>前から） は、私たちのキャッシュがまだクリアの途中であることを示します。こちらで何かする必要はありません。
✗ の行は、ご自身でしか直せないことがキャッシュのクリアを妨げていることを示し、その内容を伝えます。
設定反映: ✗ <エラー> は、サイトの設定の反映に失敗したことを、そのエラーとともに示します。

終了コード

kamakiri status は、どんなときでもページを表示します。表示した内容をすべて確かだと言えるときは0で終了します。ドメインがまだDNSを待っている場合も0です。次の場合は、ページのあとに理由を標準エラー出力に出して、1で終了します。

認証情報がないとき、または認証情報ファイルや設定ディレクトリを読めないとき。
APIが読み取りを拒否したか、応答しなかったとき。ページはその読み取りのところで止まります。
Apex ドメインの Aレコードが、サイトに必要なアドレスと一致しなくなったとき。ページに期待される値と実際の値が出るので、DNSプロバイダーでレコードを更新してください。