stax init

Scaffold a new agent or package project. Creates a ready-to-build directory structure with starter files for definitions, prompts, rules, and skills.

Usage

stax init
stax init --agent
stax init --package
stax init --template github-workflow

When run without flags, stax init prompts you to choose between an agent or package project interactively.

Options

What gets created

Agent project

my-agent/
├── agent.ts            # defineAgent() entry point
├── prompt.md           # System prompt
├── rules/              # Behavioral rules (Markdown with frontmatter)
│   └── code-style.md
├── skills/             # Reusable skill definitions
├── knowledge/          # Static reference documents
└── tsconfig.json

Package project

my-package/
├── package.ts          # definePackage() entry point
├── rules/              # Shared rules
├── skills/             # Shared skills
└── tsconfig.json

Templates

Templates provide opinionated starter configurations for specific use cases:

stax init --template github-workflow

Templates may scaffold additional files such as CI configurations, pre-populated rules for specific domains, or MCP server declarations.

After scaffolding

Once initialized, the typical workflow is:

1. Edit agent.ts to set your agent's identity, runtime, and model
2. Write your system prompt in prompt.md
3. Add rules and skills as Markdown files
4. Run stax build to produce an artifact

See Getting Started for a complete walkthrough.

Related commands

• stax build — Build the scaffolded project into an artifact
• stax validate — Check definitions without building