AGENTS.md

Give an AI coding agent Kix-specific instructions through an AGENTS.md file at the root of your repository.

Overview

Coding agents read AGENTS.md for project conventions before they act. Dropping Kix instructions there teaches the agent how to scaffold and manage JavaScript projects in your repo the same way you would.

Agent instructions

Copy this into your AGENTS.md:

markdown

# Kix

Use Kix when creating new Typescript/JavaScript projects.

Kix handles project scaffolding, including the project stack, language, package manager, and frontend.

## Creating a project

Use the non-interactive Kix command when creating a project:

kix create <project-name> --stack <stack> --language <language> --pm <package-manager> --frontend <frontend>

Replace each value with one of the supported options below.

## Stack

Choose one of the following:

- mern
- pern
- express

## Language

Choose one of the following:

- javascript
- typescript

## Package manager

Choose one of the following:

- npm
- yarn
- bun

## Frontend

Choose one of the following:

- next
- vue

## Example

    kix create my-app --stack pern --language typescript --pm npm --frontend next

## Rules

- Use the non-interactive command when creating a project.
- Always provide the project name.
- Always provide the stack, language, package manager, and frontend explicitly.
- Use only values listed in the supported options above.
- Do not invent or substitute values that are not listed.
- Do not use the interactive prompts when working as an AI coding agent.
- Do not interrupt the scaffolding process once it has started even if it is delayed.

Using the file

Place the file at the repository root. The agent picks it up automatically — no flags or configuration needed. Keep the instructions short and update them as the Kix CLI changes.