> ## Documentation Index
> Fetch the complete documentation index at: https://docs.akua.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Akua

> The packaging substrate behind every Akua installation

<Frame>
  <img className="block dark:hidden" src="https://mintcdn.com/akua-1dce587a/AEEz0U2s7Do2sYaM/images/heros/akua-index-light.svg?fit=max&auto=format&n=AEEz0U2s7Do2sYaM&q=85&s=e650ad7eb376f8a9addb9ca4d3eff0a6" alt="A package authoring loop from package files and inputs through render, preview, and installation." width="1536" height="864" data-path="images/heros/akua-index-light.svg" />

  <img className="hidden dark:block" src="https://mintcdn.com/akua-1dce587a/AEEz0U2s7Do2sYaM/images/heros/akua-index-dark.svg?fit=max&auto=format&n=AEEz0U2s7Do2sYaM&q=85&s=ad52e2694c33bc7c84b57b8b221dacdd" alt="A package authoring loop from package files and inputs through render, preview, and installation." width="1536" height="864" data-path="images/heros/akua-index-dark.svg" />
</Frame>

[Akua](https://github.com/akua-dev/akua) is the open-source packaging substrate behind Akua's per-installation renders. Every install on Akua is an akua Package: a typed, signed, deterministically-rendered KCL program that turns customer inputs into Kubernetes manifests.

You don't have to author an akua Package by hand to use Akua. The platform can synthesize one from supported sources, such as Helm charts or container images. See [Packages](/packages) for the platform contract around Package versions.

## What akua provides

| Surface                       | Purpose                                                                                 |
| ----------------------------- | --------------------------------------------------------------------------------------- |
| **`package.k`**               | Install composition: KCL logic that turns inputs into Kubernetes resources              |
| **`akua.toml` + `akua.lock`** | Pinned dependencies (Helm charts, other Packages, KCL libraries) with cosign signatures |
| **`akua render`**             | Executes the Package against customer inputs, produces deploy-ready manifests           |
| **`akua export`**             | Emits the Package's input schema as standards-pure JSON Schema 2020-12 / OpenAPI 3.1    |

A programmatic API exists for embedding akua in your own tooling. See the [akua repo](https://github.com/akua-dev/akua) for details.

## How Akua uses akua

Akua runs akua at three points in the install lifecycle:

1. **Schema for the install wizard**: Akua exports the Package's `Input` schema as JSON Schema; the wizard renders from it. UI hints from `@ui(...)` decorators flow through as `x-ui` extensions.
2. **Per-install rendering**: for every customer install, Akua renders the Package against the customer's `inputs.yaml`, vendoring upstream deps and writing the rendered manifests into the [installation repository](/installs/repositories).
3. **Version selection**: when an installation moves to a different Package version, Akua renders that installation independently.

## Where to start

<CardGroup cols={2}>
  <Card title="Package format" icon="cube" href="/akua/package-format">
    Authoring `package.k`: the `Input` schema, `@ui` annotations, composition.
  </Card>

  <Card title="Offers" icon="link" href="/marketplace/offers">
    How `@ui` drives the install wizard at `/i/<hash>` and what offers carry.
  </Card>

  <Card title="Akua repo on GitHub" icon="github" href="https://github.com/akua-dev/akua">
    Source code, full CLI reference, SDK docs, examples.
  </Card>

  <Card title="Installation repositories" icon="folder-tree" href="/installs/repositories">
    The per-install git repo that materializes a rendered Package.
  </Card>
</CardGroup>

## Status

Akua is **pre-alpha**. The Package format and CLI contract are stable enough to build on, but the CLI verb set is still iterating. Akua pins to a specific akua version per release and bumps deliberately.

For canonical, always-fresh references, the `akua` repository is authoritative. The pages here are curated for product authors building on akua within Akua; full architecture, embedded engines, security model, and roadmap docs live in the [akua docs directory](https://github.com/akua-dev/akua/tree/main/docs).

## Related topics

<CardGroup cols={2}>
  <Card title="Installation repositories" icon="folder-tree" href="/installs/repositories">
    The per-install git repository that materializes a rendered Package.
  </Card>

  <Card title="Offers" icon="link" href="/marketplace/offers">
    How your Package's schema drives the install wizard.
  </Card>

  <Card title="Customizing inputs" icon="sliders" href="/customizing-values">
    Wizard, overrides, and reviewed repository changes.
  </Card>

  <Card title="Products" icon="box" href="/products">
    Wrap a Package into a sellable product with billing.
  </Card>
</CardGroup>
