Skip to main content

AFM CLI metapackage: installs afm-core and afm-langchain

Project description

AFM CLI

PyPI version Python version License

A command-line interface for running Agent-Flavored Markdown (AFM) agents.

This package provides everything you need to run AFM agents, including:

  • afm-core: Parser, validation, and interface implementations
  • afm-langchain: LangChain-based execution backend with support for OpenAI and Anthropic

Installation

pip install afm-cli

Quick Start

1. Set your API key

export OPENAI_API_KEY="your-api-key-here"
# or
export ANTHROPIC_API_KEY="your-api-key-here"

2. Create an AFM file

Create a file named agent.afm.md:

---
name: Friendly Assistant
interfaces:
  - type: consolechat
model:
  provider: openai
  name: gpt-4o

---
# Role
You are a helpful and friendly AI assistant.

# Instructions
- Be concise but thorough in your responses
- If you don't know something, say so honestly
- Always be polite and professional

3. Run the agent

afm run agent.afm.md

This will start an interactive console chat with your agent.

Usage

afm run <file>

Run an AFM agent file and start its configured interfaces.

# Run with default settings
afm run agent.afm.md

# Run on a specific port (for web interfaces)
afm run agent.afm.md --port 8080

afm validate <file>

Validate an AFM file without running it.

afm validate agent.afm.md

afm framework list

List available execution backends.

afm framework list

Configuration

Environment Variables

  • OPENAI_API_KEY - Required for OpenAI models
  • ANTHROPIC_API_KEY - Required for Anthropic models

CLI Options

  • -p, --port PORT - Port for web interfaces (default: 8085)
  • --help - Show help message

Features

Interface Types

AFM agents can expose multiple interfaces simultaneously:

  • consolechat: Interactive terminal-based chat (default)
  • webchat: HTTP API with built-in web UI
  • webhook: Webhook endpoint for event-driven agents

MCP Tool Support

Agents can use external tools via Model Context Protocol (MCP).

For more examples and detailed documentation, see AFM Examples.

Docker

You can also run agents using Docker:

# Build the image
docker build -t afm-langchain-interpreter .

# Run with an AFM file mounted
docker run -v $(pwd)/agent.afm.md:/app/agent.afm.md \
  -e OPENAI_API_KEY=$OPENAI_API_KEY \
  -p 8085:8085 \
  afm-langchain-interpreter afm /app/agent.afm.md

Documentation

For more detailed documentation, see the project README.

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

afm_cli-0.4.0.tar.gz (2.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

afm_cli-0.4.0-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file afm_cli-0.4.0.tar.gz.

File metadata

  • Download URL: afm_cli-0.4.0.tar.gz
  • Upload date:
  • Size: 2.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for afm_cli-0.4.0.tar.gz
Algorithm Hash digest
SHA256 9f90e9cb07e5d5dc27ee28b7b5bf11679e9934be2bbaeea950123f380a91daa0
MD5 73e421791930c23b9bf025ba77de1b79
BLAKE2b-256 2464b7402cabe96b20ce793ec47e0ce43841231615de0e229d1270c262e471ac

See more details on using hashes here.

File details

Details for the file afm_cli-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: afm_cli-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 3.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for afm_cli-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0716f2ee1cd99ff019c823c7391943cef6753b5c5d046a881de3c03217749677
MD5 307c1441c732cc801ef7552eaf141452
BLAKE2b-256 5fa7ff16bb29f6e89de904ca95dc5a643082182cd12f418ba84cff02af7c48b8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page