Skip to content
Takuhon

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.

1. Scaffold a profile

Section titled “1. Scaffold a profile”
Terminal window
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

Section titled “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.

3. Deploy to the edge

Section titled “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 page at /, as JSON at /api/profile, and as JSON-LD at /api/jsonld.

Next steps

Section titled “Next steps”