Skip to content
Fractary Developers

CLI Reference

CLI Reference

Section titled “CLI Reference”

Complete reference for all Faber commands available through the Fractary CLI.

Global Commands

Section titled “Global Commands”

fractary --version

Section titled “fractary --version”

Display the installed version of the Fractary CLI.

Terminal window
fractary --version

fractary faber --help

Section titled “fractary faber --help”

Display help for Faber commands.

Terminal window
fractary faber --help

Project Management

Section titled “Project Management”

fractary faber init

Section titled “fractary faber init”

Initialize a new Faber project in the current directory.

Terminal window
fractary faber init [options]

Options:

  • --org <name> - Set organization name (default: prompts)
  • --force - Overwrite existing configuration

Creates:

  • .faber/config.yml - Project configuration
  • .faber/overlays/ - Organization overlays directory
  • roles/, tools/, teams/, workflows/ - Core directories
  • deployments/ - Build output directory

Creation Commands

Section titled “Creation Commands”

fractary faber create role

Section titled “fractary faber create role”

Create a new role (agent) definition.

Terminal window
fractary faber create role <name> [options]

Arguments:

  • <name> - Role name (kebab-case recommended)

Options:

  • --system <name> - System the role belongs to
  • --platforms <list> - Comma-separated platform list
  • --template <name> - Use a template (default, minimal, full)

Example:

Terminal window
fractary faber create role issue-manager \
  --system devops \
  --platforms github-issues,linear

fractary faber create tool

Section titled “fractary faber create tool”

Create a new tool (MCP server or utility).

Terminal window
fractary faber create tool <name> [options]

fractary faber create team

Section titled “fractary faber create team”

Create a new team composition.

Terminal window
fractary faber create team <name> [options]

fractary faber create workflow

Section titled “fractary faber create workflow”

Create a new workflow definition.

Terminal window
fractary faber create workflow <name> [options]

Build Commands

Section titled “Build Commands”

fractary faber build

Section titled “fractary faber build”

Build agent definitions for target frameworks.

Terminal window
fractary faber build <framework> <type> <name> [options]

Arguments:

  • <framework> - Target framework: claude, langgraph, crewai
  • <type> - Asset type: role, team, workflow
  • <name> - Name of the asset to build

Options:

  • --output <dir> - Custom output directory
  • --overlay <name> - Apply specific overlay
  • --watch - Rebuild on file changes
  • --verbose - Show detailed build output

Examples:

Terminal window
# Build for Claude Code
fractary faber build claude role issue-manager


# Build for LangGraph
fractary faber build langgraph role issue-manager


# Build for CrewAI with custom output
fractary faber build crewai role issue-manager --output ./agents


# Build and watch for changes
fractary faber build claude role issue-manager --watch

fractary faber build-all

Section titled “fractary faber build-all”

Build all assets for a target framework.

Terminal window
fractary faber build-all <framework> [options]

Validation Commands

Section titled “Validation Commands”

fractary faber validate

Section titled “fractary faber validate”

Validate agent definitions against schema.

Terminal window
fractary faber validate <type> <name> [options]

Arguments:

  • <type> - Asset type: role, team, workflow
  • <name> - Name of asset to validate

Options:

  • --strict - Enable strict validation mode
  • --schema <path> - Use custom schema file

Example:

Terminal window
fractary faber validate role issue-manager

fractary faber validate-all

Section titled “fractary faber validate-all”

Validate all agent definitions in the project.

Terminal window
fractary faber validate-all [options]

Overlay Commands

Section titled “Overlay Commands”

fractary faber overlay create

Section titled “fractary faber overlay create”

Create a new organization overlay.

Terminal window
fractary faber overlay create <org> [options]

fractary faber overlay apply

Section titled “fractary faber overlay apply”

Preview overlay application.

Terminal window
fractary faber overlay apply <org> <type> <name>

Utility Commands

Section titled “Utility Commands”

fractary faber list

Section titled “fractary faber list”

List all assets in the project.

Terminal window
fractary faber list [type]

Arguments:

  • [type] - Optional: filter by type (roles, tools, teams, workflows)

fractary faber info

Section titled “fractary faber info”

Show information about an asset.

Terminal window
fractary faber info <type> <name>

fractary faber clean

Section titled “fractary faber clean”

Remove generated build artifacts.

Terminal window
fractary faber clean [options]

Options:

  • --framework <name> - Clean specific framework only
  • --all - Clean all generated files

Configuration

Section titled “Configuration”

Project Configuration

Section titled “Project Configuration”

Edit .faber/config.yml to configure:

org: acme
version: 1.0.0
frameworks:
  claude:
    output: .claude/agents
  langgraph:
    output: langgraph/graphs
  crewai:
    output: crewai/agents
defaults:
  role_template: default
  platforms: [github-issues]

Environment Variables

Section titled “Environment Variables”
  • FABER_ORG - Override organization name
  • FABER_DEBUG - Enable debug logging
  • FABER_CONFIG - Custom config file path

Exit Codes

Section titled “Exit Codes”
  • 0 - Success
  • 1 - General error
  • 2 - Validation error
  • 3 - Build error
  • 4 - Configuration error

Next Steps

Section titled “Next Steps”