始める

crofty は、あなたが覚えて使うのではなく、アシスタントに動かしてもらうためのツールです。だから手順はふたつ、あなたがやるのは最初のひとつだけ ── インストールして、AI に指示のブロックを渡します。

1. crofty をインストールする

ダウンロードして、ダブルクリック。前もって用意するものはありません ── サイトの生成に使う Hugo も同梱されています。

OS が警告を出します。想定どおりです。

macOS も Windows も、見たことのないプログラムの初回起動はいったん止めます。ターミナルを開かずに、そのまま進められます。

macOS。 初回は開けません ──「crofty.pkg は、開発元を確認できないため開けません」。OK を押します。そのあと システム設定 → プライバシーとセキュリティ を開き、セキュリティ まで下ると crofty.pkg についての行があるので、このまま開く を押します。確認するとインストーラが起動します。

このまま開く は、一度弾かれた あと にしか出てきません。見当たらないときは、.pkg をもう一度開いてから探してください。

Windows。 SmartScreen が「Windows によって PC が保護されました」と出し、見えるボタンは 実行しない だけです。詳細情報 を押すと、下に 実行 ボタンが現れます。管理者パスワードは要りません ── crofty はあなたのアカウントの中に入ります。

2. アシスタントに渡す

これをコピーして、あなたの AI アシスタント(Codex・Copilot・Gemini・OpenCode など)に貼ってください。サイトを作ります ── あなた自身がターミナルを開くことはありません。

crofty をインストールしました。Markdown を「自分が所有するサイト」に変える CLI です。
`crofty agent` を実行して、私のサイトを用意して。

セットアップはこれだけ。あとはアシスタントが引き取ります。

公開する前に

前もって用意するものはありません ── ただ、公開するときには次があると進みます:

自分で入れたい場合は

インストーラは最短の道であって、唯一の道ではありません。下のどちらを通っても、手に入るのは同じ1つのバイナリです。そして最初の道に必要なのはブラウザだけです。

アーカイブを落とす

Linux を含め、どの OS でも通ります。

  1. 最新リリース を開き、OS と CPU に合うアーカイブを落とします ── crofty_<version>_windows_amd64.zipcrofty_<version>_linux_arm64.tar.gz などです。
  2. 展開します。中身は crofty バイナリ1つだけです。
  3. 好きな場所へ移します。その場所に PATH を通しておくと入力が短くて済みますが、必須ではありません。フルパスで呼んでも同じように動きます。

.crofty/ の中には展開しないでください。その名前は crofty がサイトごとの状態を置く場所で、crofty init が書き込みます。

あるいはワンライナーで

curl -fsSL https://crofty.site/install.sh | sh                                          # macOS / Linux
irm https://github.com/ShiroDoromoto/crofty/releases/latest/download/install.ps1 | iex  # Windows

うまくいくときの近道です。Windows では OS の TLS がダウンロードそのものを拒むことがあります(SEC_E_NO_CREDENTIALS)。そのときは上のアーカイブを使ってください。ブラウザなら通ります。

スクリプトは crofty を ~/.local/bin に置くだけで、ほかには何も触りません。システム全体に入れるなら、置き場所を指定してください: curl -fsSL https://crofty.site/install.sh | sudo PREFIX=/usr/local sh

どちらもバイナリだけを入れます。crofty は PATH の Hugo(extended 版)を使います ── 同梱しているのはクリックインストーラだけです。

ほかの入れ方

自分でダウンロードしたものを検証したい場合のために、各リリースには crofty_<version>_checksums.txt が同梱されています。

手動フローの全手順

これらを自分で実行する必要はありません ── エージェントが行います。crofty agent がたどる手順そのものです。

サイトを作る ── ゼロから、または Git 管理中の既存フォルダの中で。デプロイ先は既定で Cloudflare。自分のサーバーへ公開するなら --provider sftp(または ftps)を渡します:

crofty init        # ~/Documents/Crofty/ の下に新規プロジェクト
crofty init .      # または構成をそのままに、その場でセットアップ
crofty init --provider sftp --host example.com --user me --path /var/www/site

見て、あなた自身のホストへ公開:

crofty preview     # ローカルで開く ── まだアカウント不要
crofty connect     # デプロイ認証情報をキーチェーンに保存
crofty deploy      # あなたのホストへ公開 ── Cloudflare Pages、または自分の SFTP/FTPS サーバー
crofty share       # 概要+リンクを表示。好きな場所に貼る

下書きと予約公開 ── 標準の Hugo の機能で、crofty 固有のものはありません: draft: true でビルドから外し、未来の date でその日まで保留。crofty build が除外分を一覧で知らせます。

自分のものにする:

crofty theme set quiet-paper   # ほかに: terminal, serif(既定)
crofty theme eject             # テーマの設定値を取り出して手で調整
crofty features                # できること一覧と、各機能の有効化方法
crofty add mermaid             # ひとつ有効化(ほかに: abc, highlight, raw-html, analytics)

支援を受けたいときは、data/profile.ymlsupport に Stripe / GitHub Sponsors / Ko-fi のリンクを書き加えます ── フッタに表示され、お金が crofty を経由することはありません。

アップデート

crofty はインストールした方法でそのまま更新できます。

ダブルクリックで入れた場合。 最新リリース から新しい .pkg / .exe をダウンロードして、もう一度ダブルクリックします。OS は初めて見るダウンロードごとに警告するので、また出ます。同じ手順で進めてください。

ターミナルから入れた場合。 同じ一行をもう一度実行します。

curl -fsSL https://crofty.site/install.sh | sh                                          # macOS / Linux
irm https://github.com/ShiroDoromoto/crofty/releases/latest/download/install.ps1 | iex  # Windows

croftyは古くなると教えてくれます。何かコマンドを実行したとき、新しい版が 出ていれば、あなたのインストール方法に合った更新用の一行を表示します。

Homebrew・Scoop・.deb / .rpm で入れていた場合。 これらの経路はもう更新されません。 一度出て(brew uninstall crofty && brew untap ShiroDoromoto/croftyscoop uninstall crofty && scoop bucket rm croftysudo apt remove croftysudo dnf remove crofty)、インストーラかスクリプトで戻ってきてください。書いたものには何も起きません。

コンテンツは素の Markdown、テーマは固定された出力仕様なので、更新で書いたものが 書き換わることはありません ── ビルドは crofty doctor が引き続き検証します。新機能は crofty agent に現れるので、あなたのアシスタントは次に読んだときに拾います。覚え直しは不要。

やめたくなったら

囲い込みは一切ありません。コンテンツは素の Markdown、ビルド結果は crofty 無しでも保持・運用できる普通の Hugo サイトです。アンインストールについて →