Publishing to Registry

Publish formations to the MUXI Registry so others can use them. Once published, anyone can install your formation with muxi pull @yourname/formation.

Prerequisites

1. MUXI account
2. Formation ready for distribution
3. CLI authenticated

Authenticate

muxi login

Opens browser for authentication.

Prepare Formation

Required Metadata

Add to formation.afs:

schema: "1.0.0"
id: my-formation
name: My Formation
description: A helpful AI assistant

# Registry metadata
author: your-username
license: MIT
tags:
  - assistant
  - chat
repository: https://github.com/user/my-formation

Create secrets

Document required secrets:

# Required secrets
OPENAI_API_KEY=

Add README

Create README.md in formation directory:

# My Formation

Description of what this formation does.

## Quick Start

1. Pull the formation
2. Set up secrets
3. Run

## Configuration

Describe any configuration options.

Publish

muxi push

Output:

Publishing my-formation...
✓ Validated formation
✓ Bundled (2.3MB)
✓ Published to registry

Available at: https://registry.muxi.org/@you/my-formation

Publishing

muxi push

Publishes to your namespace (@username/formation).

Versioning

Automatic

Versions auto-increment on push.

Manual

muxi push --tag v1.0.0

Semantic Versioning

v1.0.0  # Initial release
v1.1.0  # New features
v1.1.1  # Bug fixes
v2.0.0  # Breaking changes

Update Formation

Edit and push again:

# Make changes
muxi push

Previous versions remain available.

Unpublish

Best Practices

1. Clear description - Explain what it does
2. Document secrets - List required credentials
3. Include README - Usage instructions
4. Add tags - Help discovery
5. Version properly - Follow semantic versioning
6. Test before publish - Run muxi validate

Validation

Check before publishing:

muxi validate

Checks:

• Schema validity
• Required fields
• secrets exists
• README exists (warning if missing)