Documentation for the libtmux libraries in Python, TypeScript, Rust, Go, Java/Kotlin, .NET, C++, and Swift. libtmux.org provides installation instructions, task guides, examples, and API references with links between corresponding APIs in different languages.
Use Node.js 24 or newer and the pnpm version declared in package.json.
Install dependencies:
$ pnpm installStart the Astro development server:
$ pnpm devThis serves the site shell with the cached API models and example sources. See Contributing for the full check suite and port source requirements.
Build the Astro shell:
$ pnpm buildAssemble the shell, port documentation, reference pages, and search index
into _site/:
$ pnpm build:siteServe the assembled site at http://localhost:8080:
$ ./scripts/serve.shBuild scripts documents build options, caching, and which generated references require sibling port checkouts.
| Path | Contents |
|---|---|
site/ |
Astro components, guides, examples, and reference pages |
packages/api-model/ |
API extraction, symbol resolution, and cross-port mappings |
packages/theme/ |
Shared Tailwind theme plugin |
scripts/ |
Site assembly, generated data, and validation |
infra/ |
Hosting configuration for S3 and CloudFront |
notes/ |
Architecture and port integration guidance |
ports.ts defines port identities, source locations, and renderers. versions.ts defines version ordering and canonical URL policy.
Each port has an API reference on this site. Rust, Go, and Java also link to docs.rs, pkg.go.dev, and javadoc.io.
Read Architecture for the build and hosting design, Adding a port for integration steps, and Writing for documentation conventions.