kikx documentation

The docs follow Diátaxis: four kinds of documentation for four different needs.

Tutorials

Learn kikx by building something.

Start here if you’re new. Each one builds a working project from scratch.

1. Your first project with the CLI

2. Build an Ansible platform in the dashboard

How-to guides

Get a specific task done.

Recipes for a specific goal, assuming you know the basics.

• Import an existing Ansible inventory

• Write a multi-play playbook with role conditions

• Manage group vars as YAML or a folder

• Wire playbooks together with a site playbook

• Scaffold the roles your playbooks use

• Resolve file conflicts and checks

• Share a project as a preset

• Export the architecture to draw.io

• Render your own component from a registry item

Explanation

Why kikx works the way it does.

Background and design decisions.

• Vendoring real files

• The registry as single source of truth

• How rendering works

• How the architecture diagram is drawn

• How the pieces fit together

Reference

Exact commands, fields and formats.

Exact, complete facts to look things up.

• CLI

• Components

• HTTP API

• Configuration

• Preset format

• Registry item format

• Checks