Get started

Takuhon turns your profile into a portable takuhon.json document and serves it as a mobile-first page, a JSON API, and JSON-LD. This page takes you from zero to a deployed profile. If you want the model before the mechanics, read A portable profile first.

Stable schema (1.0.0)

Takuhon’s takuhon.json schema is frozen at 1.0.0 as a stable contract: a conforming document keeps working across releases, and any breaking change would ship as a new major version. The CLI ships validate, dev, build, sync, admin, and migrate. Minor releases still add fields and commands without breaking the contract — see Schema stability and Installation for the current published version.

1. Scaffold a profile

npx --package=@takuhon/cli create-takuhon my-profile

This sets up a minimal Cloudflare Workers project in my-profile/: a starter takuhon.json, a wrangler.toml, a Worker entry point, and a prompt for which content license to apply to your profile data. See Installation for prerequisites and a global-install alternative.

2. Edit your profile

Your profile lives in one canonical file, takuhon.json — add your bio, links, career history, and skills. See The takuhon.json file for the full structure and the multilingual field format.

Prefer a visual editor? The admin form edits the same document with typed fields, multilingual tabs, and validation — see Edit your profile.

3. Deploy to the edge

The generated project deploys to Cloudflare Workers with Wrangler: create a KV namespace, set an admin token, and run wrangler deploy. The full deploy flow, routes, and admin API are documented in the @takuhon/cloudflare adapter README.

Once deployed, your profile is served as a server-rendered page at / (and /<locale>/ for each language) with Schema.org JSON-LD embedded for search engines and AI agents, as JSON at /api/profile, and as standalone JSON-LD at /api/jsonld.

Next steps

• A portable profile — the idea behind Takuhon
• JSON-LD for AI and search
• Adapters — where your profile runs
• The takuhon.json file