Getting started

Install

Run the install script, in a terminal on Linux and macOS or in PowerShell on Windows.

$ 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.

If ~/.local/bin is missing from your PATH, the script tells you how to add it.

You can also install the client with Homebrew or npm. See The kamakiri CLI.

Log in

kamakiri login sends a confirmation code to your email address. Type the code at the prompt, and the client saves an API key that every later command uses.

$ 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 に保存しました

The beta is by invitation. An address that has not been invited is refused before any code is sent. To request an invitation, see Join the beta.

Write a page

Save this as dist/index.html:

<!doctype html>
<meta charset="utf-8">
<title>My site</title>
<link rel="stylesheet" href="/style.css">
<h1>Hello from Kamakiri Pages.</h1>
<p>This page came out of a deploy.</p>

Save body { font-family: system-ui; } as dist/style.css.

Link the directory to a site

Run kamakiri init in the directory that holds dist/, not in dist/ itself. It asks for a subdomain, creates the site, and links the directory to it.

$ kamakiri init
Subdomain: my-site
Creating site... done.
Saved to .kamakiri/config.json

$ kamakiri init
サブドメイン: my-site
サイトを作成中... 完了しました。
.kamakiri/config.json に保存しました

Commit .kamakiri/config.json. It holds no secret, and it lets a collaborator or a CI job deploy to the same site.

Deploy

$ 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

The command returns once visitors get the new files, and the URL on the ✓ live line is your site. To publish a change, run your build and kamakiri deploy ./dist again.

Deploy covers the limits, rolling back and deploying from CI. Custom domains covers serving the site on your own domain.