Getting Started

stax provides a TypeScript-first authoring experience for defining agents and packages. Every definition uses a typed helper function that validates your configuration at build time.

Quick Start

Initialize a new agent

stax init --agent

Define your agent

agent.ts

import { defineAgent } from "stax";

export default defineAgent({
  name: "backend-engineer",
  version: "3.1.0",
  persona: "./personas/maya-chen.ts",
  prompt: "./prompt.md",
  mcp: "./mcp.ts",
  skills: "./skills/",
  rules: "./rules/",
  packages: ["@acme/coding-standards@^1.0.0"],
  adapter: {
    type: "claude-code",
    runtime: "claude-code",
  },
});

Build the artifact

stax build

Push to a registry

stax push ghcr.io/myorg/agents/backend-engineer:3.1.0

Materialize into a runtime

stax materialize ghcr.io/myorg/agents/backend-engineer:3.1.0 --out ./output

Project Structure

After running stax init --agent, your project will look like this:

agent.ts

SYSTEM_PROMPT.md

persona.ts

mcp-servers.ts

_base.ts

maya-chen.ts

.staxignore

stax.lock

Next Steps

Defining an Agent

Full reference for defineAgent() including identity, layers, adapters, secrets, and hints

Defining a Package

Create reusable bundles of skills, rules, MCP config, and knowledge

Defining a Persona

Author rich persona definitions with traits, communication style, and prompt templates

Defining an Agent

Defining a Package

Defining a Persona

On this page