Quickstart

Takosumi has two entry points.

Takosumi software:
  verify the OpenTofu control plane on a self-hosted, local, or operator endpoint

Takosumi Cloud:
  use the official hosted service and managed resources at app.takosumi.com

Start with OSS / local runner when you want to verify Takosumi as software. Use the Takosumi Cloud flow when you want the hosted service.

OSS / local runner

Takosumi runs plain OpenTofu stacks as-is with existing OpenTofu/Terraform providers. The shortest useful check is to register examples/opentofu-basic as a Git Source and verify normal plan/apply/destroy and Output recording without any provider or credential. When a selected module uses a provider, register the credentials defined by that provider as a ProviderConnection.

Prerequisites

• Bun
• OpenTofu CLI (tofu)
• Git
• a provider credential only when the selected module requires one

1. Start the service

cd takosumi
bun install

export TAKOSUMI_DEV_MODE=1
export TAKOSUMI_DEPLOY_CONTROL_TOKEN=dev-token
PORT=8788 bun core/index.ts

In another terminal:

export BASE=http://127.0.0.1:8788
export AUTH="Authorization: Bearer dev-token"

2. Add a Git URL in /new

The standard product flow is the dashboard /new route. External links such as /install?git=...&ref=...&path=... only prefill /new; they do not perform a server-side install.

The user explicitly reviews:

Git URL
compatibility check
ProviderConnection selection
plan result
apply approval

3. ProviderConnection (when provider authentication is required)

Credentials are stored in ProviderConnections, not in .env files or manifests.

takosumi connections create \
  --provider registry.opentofu.org/example/example \
  --recipe generic-env \
  --auth-mode env \
  --secret-partition provider-credentials \
  --values-file <path-to-provider-credential-env-json>

example/example is a placeholder. Use the source and env/file names declared by the module's required_providers block and the provider's own documentation. Takosumi injects those values only into the runner sandbox while the Run is active; it does not infer a credential schema or RunnerProfile from the provider name.

4. Result

When a Run succeeds, Takosumi stores:

run log
plan/apply result
state version
outputs
audit event

This quickstart focuses on the OpenTofu Stack flow. Compatibility API framework is an OSS Takosumi capability surface, while official managed target pools, Takosumi-owned native resource internals, enforced billing, and support/SLA belong to the Takosumi for Operator / Cloud operation layer.

Hosted Cloud flow

The hosted service at app.takosumi.com, including managed resources, pricing, API keys, usage, and spend guard behavior, is documented separately in Takosumi Cloud docs.

Cloud uses the same underlying software model, but this quickstart covers only the portable Takosumi software / operator endpoint behavior.