Skip to main content

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.

Helm chart and git sources composed into a readable Package version card with field, type, and default rows, reused by Product, Offer, and Direct install
A Package is the reusable install definition behind an Akua install. It owns the composition logic, dependencies, version history, and input schema that the dashboard, API, and offer wizard use. Products and Offers build on Packages. A Product is the sellable wrapper customers discover or buy. An Offer is the shareable sales path for a Product or Package version. The Package is the technical contract both of them point at.

​
What a Package owns

SurfaceOwned by Package
SourceHelm chart, repository, image, or authored package.k source metadata
VersionsImmutable Package versions with provenance and renderable inputs
Input schemaThe customer-facing fields exported from the Package version
DefaultsSafe default inputs used by products, offers, and direct installs
CompatibilityThe install shape a workspace must satisfy before using the Package
Packages do not own pricing, customer targeting, payment collection, or marketplace visibility. Those belong to Products and Offers.

​
Package, Product, Offer

Package version
  Input schema
  Product
    Marketplace listing or Offer
      Order draft
        Installation
  Package Offer
    Order draft
      Installation
  Direct install
    Installation
Use this split when you design your catalog:
  • Create or import a Package when you need a reusable install definition.
  • Create a Product when that Package should become a sellable catalog item.
  • Create an Offer when you want to send a customer a short URL with selected inputs, access rules, and commercial terms.
  • Use a Direct install when the Package should run internally without Product or Offer wrapping.

​
Input schemas

Akua exports each Package version’s Input schema to drive generated forms. Docstrings become help text. @ui(...) annotations control grouping, ordering, widget hints, placeholders, and numeric bounds. For authoring details, see Package format. For the customer-facing generated form, see Offers.

​
API

Manage Packages programmatically from the generated API reference.

Packages API

Create Packages, inspect versions, and fetch input schemas.

Products API

Wrap a Package into a sellable product.

Offers API

Create private or reusable sales paths for a Product or Package version.

OpenAPI

Download the generated specification and SDKs.

Products

Turn a Package into a sellable catalog item.

Package format

Author package.k, Input, and @ui annotations.

Installation repositories

See how a Package version materializes for each install.

Offers

Send customers a short URL into the generated install wizard.