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

# What is Inkly?

> Learn how Inkly turns product demos into repo-backed, AI-maintainable demo hubs.

Inkly is a product demo platform built for both people and AI agents.

You use Inkly to capture, author, customize, publish, and maintain interactive demos. Humans can work in the no-code editor or Chrome extension. AI agents can work through the CLI and edit the same demo files directly.

The core idea is **Demo as Code**. Your demos live in a repository. Inkly reads that repository, validates the files, hosts the demo hub, serves each demo, and updates the published experience when the source changes.

## Why Demo as Code

Most demo tools keep the source of a demo inside a closed visual editor. Inkly keeps the source in files.

That makes demos easier to create and maintain:

* AI agents can read, understand, and edit the demo source directly.
* Demo creation becomes part of your daily workflow, not a separate production process.
* You can bring your own agents, such as Codex, Claude Code, or Cursor.
* You can keep live demos current as your product changes.
* You can reuse screenshots, videos, product copy, and marketing materials.
* You can preview changes before your audience sees them.
* You can keep ownership of the source in your own repository.

## The four parts of Inkly

Inkly has four main parts: your repository, the Inkly platform, the deployed demo experience, and authoring harnesses for humans and agents.

<CardGroup cols={2}>
  <Card title="Repository" icon="folder" href="#your-repository">
    The source of truth for hubs, demos, config, and assets.
  </Card>

  <Card title="Platform" icon="layer-group" href="#the-inkly-platform">
    The hosted place to edit, configure, publish, and measure demos.
  </Card>

  <Card title="Deployed experience" icon="globe" href="#the-deployed-hub-and-demos">
    The public hub and demos your audience can view or embed.
  </Card>

  <Card title="Authoring harnesses" icon="terminal" href="#authoring-harnesses">
    The CLI, Chrome extension, and editor for creating and polishing demos.
  </Card>
</CardGroup>

### Your repository

Your repository is the source of truth for your demos. It has two levels:

* A **hub** is the workspace for a collection of demos. It becomes a public demo hub you can use for sales, onboarding, customer support, product education, or feature showcases.
* A **demo** is one interactive walkthrough inside the hub. A demo can be captured, edited, customized, and maintained by a person or an AI agent.

A hub uses `inkly.json` for hub configuration and `demos/<slug>/demo.config.json` for each demo. Inkly can create and manage the repository for you, or you can connect your own GitHub repo so GitHub remains the system of record.

### The Inkly platform

The Inkly platform is where you manage the hosted experience. You can edit demos in a no-code editor, customize themes and settings, review analytics, manage embeds and API keys, and configure publishing.

The platform writes changes back to the same file-backed model, so visual edits and agent edits do not create separate sources of truth.

### The deployed hub and demos

Inkly publishes the hub and demos from your repository. The deployed hub is a public page for your audience, and each demo is viewable as its own interactive experience.

When you are ready, you can point a custom domain at your hub. You can also embed the hub or a demo in another site.

### Authoring harnesses

Inkly includes tools for both human and AI-backed authoring.

The CLI helps agents capture and maintain demos. It can open Chrome, inspect the page, navigate by stable element references, capture screenshot/video or HTML steps, and write a demo folder.

The Chrome extension helps humans record a demo by clicking through a product in their own browser. It uses the session you already have open, which is useful for logged-in product flows.

The no-code editor lets you polish the demo without editing JSON. You can adjust copy, annotations, steps, branding, theme settings, voiceover, and assets from the web app.

## How the workflow fits together

<Steps>
  <Step title="Create or connect a hub">
    Start with a hub in a repository. Use the CLI to scaffold one, or connect a GitHub-backed hub from the platform.
  </Step>

  <Step title="Create a demo">
    Capture a product flow with the CLI or Chrome extension. You can also create and edit demos directly in the platform.
  </Step>

  <Step title="Customize and review">
    Use the no-code editor, an AI agent, or direct file edits. Preview locally with the CLI before publishing.
  </Step>

  <Step title="Publish and measure">
    Inkly hosts the hub and demos, keeps managed assets available, and records analytics so you can improve the experience.
  </Step>
</Steps>

## Where to go next

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/get-a-quick-start">
    Create your first demo with an agent or the Chrome extension.
  </Card>

  <Card title="Hubs and demos" icon="folder" href="/concepts/hubs-and-demos">
    Learn the file-backed model behind a hub.
  </Card>

  <Card title="Install the CLI" icon="terminal" href="/cli/install">
    Install `inkly` and start working with local demo workflows.
  </Card>

  <Card title="Platform overview" icon="layer-group" href="/platform/overview">
    Learn what the hosted platform adds on top of the repository.
  </Card>
</CardGroup>