はじめに
インストール
Linux と macOS ではターミナルで、Windows では PowerShell でインストールスクリプトを実行します。
$ curl -fsSL https://get.kamakiri-labs.jp/install.sh | sh
Checking for the latest release.
Downloading kamakiri-linux-amd64 into ~/.local/bin.
Checksum verified against checksums.txt.
Installed v0.3.0 at ~/.local/bin/kamakiri.
PS> irm https://get.kamakiri-labs.jp/install.ps1 | iex
Checking for the latest release.
Downloading kamakiri-windows-amd64.exe into C:\Users\you\.local\bin.
Checksum verified against checksums.txt.
Installed v0.3.0 at C:\Users\you\.local\bin\kamakiri.exe.
C:\Users\you\.local\bin was not on your PATH, so it has been added to your user environment.
This session has it now, and new terminals pick it up, so 'kamakiri version' will work.
~/.local/bin が PATH に入っていない場合は、追加する方法をスクリプトが表示します。
Homebrew や npm でもインストールできます。詳しくは kamakiri CLI をご覧ください。
ログイン
kamakiri login は、メールアドレスに確認コードを送ります。プロンプトにコードを入力すると、クライアントがAPIキーを保存し、以降のコマンドはすべてこのキーを使います。
$ kamakiri login
Email: user@example.com
Terms of Service: https://kamakiri-labs.jp/en/terms/
Privacy Policy: https://kamakiri-labs.jp/en/privacy/
Accept Terms of Service? (Y/n) Y
Confirmation code sent to user@example.com.
Code: 4b1d9e2f7c8a3b6d5e0f1a2b3c4d5e6f
API key saved to ~/.config/kamakiri/credentials.json
$ kamakiri login
メールアドレス: user@example.com
利用規約: https://kamakiri-labs.jp/ja/terms/
プライバシーポリシー: https://kamakiri-labs.jp/ja/privacy/
利用規約に同意しますか? (Y/n) Y
user@example.com に確認コードを送信しました。
確認コード: 4b1d9e2f7c8a3b6d5e0f1a2b3c4d5e6f
APIキーを ~/.config/kamakiri/credentials.json に保存しました
ベータは招待制です。招待されていないメールアドレスは、コードが送られる前に断られます。招待はベータへの申し込みのページからお申し込みください。
ページを書く
次の内容を dist/index.html として保存します。
<!doctype html>
<meta charset="utf-8">
<title>マイサイト</title>
<link rel="stylesheet" href="/style.css">
<h1>Kamakiri Pages から、こんにちは。</h1>
<p>デプロイで公開されたページです。</p>
body { font-family: system-ui; } の1行を dist/style.css として保存します。
ディレクトリをサイトに紐付ける
kamakiri init は、dist/ のなかではなく、dist/ を置いたディレクトリで実行します。サブドメインを尋ねてサイトを作成し、そのディレクトリをサイトに紐付けます。
$ kamakiri init
Subdomain: my-site
Creating site... done.
Saved to .kamakiri/config.json
$ kamakiri init
サブドメイン: my-site
サイトを作成中... 完了しました。
.kamakiri/config.json に保存しました
.kamakiri/config.json はコミットしてください。秘密の情報は入っておらず、共同作業者やCIのジョブが同じサイトにデプロイするのに使います。
デプロイ
$ kamakiri deploy ./dist
Uploading 2 files (0.3 KB)... done (0.0s).
Deploying...
Deploy: 20260919-165349-736
✓ live: https://my-site.kamakiri-pages.jp
$ kamakiri deploy ./dist
アップロード中: 2件のファイル (0.3 KB)... 完了しました(0.0秒)。
デプロイ中...
デプロイ: 20260919-165349-736
✓ 公開中: https://my-site.kamakiri-pages.jp
コマンドは、訪問者に新しいファイルが届くようになってから終了します。✓ 公開中 の行のURLが、公開されたサイトのアドレスです。変更を公開するときは、ビルドしてから kamakiri deploy ./dist をもう一度実行します。