kamakiri status

kamakiri status shows the client version, the credential in use, and where the linked site and its addresses stand. It answers even on a machine where nothing is set up.

Usage

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

• --verbose, or -v, shows the DNS records for every custom domain, not only for those that still need action.
• --recheck asks the server to check the DNS of each custom domain that is not yet serving, as kamakiri domain verify does, before showing the page. Rechecks are rate-limited. When one is refused, the page shows the latest result and the command does not fail.

The page

With no credential, the page still renders, and the reason follows it.

$ 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キーを設定してください

While KAMAKIRI_API_KEY holds a key, Credentials names the variable and the credentials file is not read. Logged in reads yes, since the variable carries no email address.

$ 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
サイト:        （なし）

After kamakiri login, Credentials names the credentials file and Logged in shows the address the key was saved for. In a directory linked to a site, the Site line gives way to the site’s addresses and your usage against your plan.

$ 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

• Subdomain carries a ✓ once the address serves the site as configured and the last change has finished.
• Domain shows the canonical custom domain, or (none).
• Sites counts the sites on your account, Snapshots the deploys kept for this site, and Max deploy is the size limit of one deploy.

Custom domains

Each custom domain gets a block with its DNS and CDN state, and the DNS records to publish under any row that still needs action. The DNS line opens with a status such as ⧗ waiting for your DNS, ⚠ DNS points at the wrong target, ⚠ couldn't reach your DNS, ⧗ this site has no published content yet, ⧗ verifying edge, ⧗ provisioning SSL certificate and ✓ live. Custom domains says what each means and what to do.

A deploy going live

While a visitor could still get an older deploy, the page shows what a waiting command would be waiting on. Use it after a Ctrl-C, or from another machine.

• ⧗ still going live: the deploy is still being published.
• Edge cache: still flushing (since <age>): our own cache is still clearing. It needs nothing from you.
• A ✗ line: something only you can fix is blocking a cache flush. The line names it.
• Reconcile: ✗ <error>: applying the site’s configuration failed, with the error.

Exit status

kamakiri status always prints the page. It exits 0 when it can vouch for everything on it, including while a domain is still waiting for DNS. It exits 1, with the reason on stderr after the page, when:

• there is no credential, or the credentials file or config directory cannot be read;
• the API refused or did not answer a read, in which case the page stops at that read;
• an apex domain’s A records no longer match the addresses the site needs. The page lists the expected and observed values; update the records at your DNS provider.