From 467b5cc90e76998fc78c70fbd8274f570051cd1a Mon Sep 17 00:00:00 2001 From: Vincent Grobler Date: Thu, 14 May 2026 17:34:24 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20add=20CLI=20tool=20to=20README=20?= =?UTF-8?q?=E2=80=94=20Quick=20Start,=20features=20grid,=20and=20documenta?= =?UTF-8?q?tion=20table?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7874ccb..d32d683 100644 --- a/README.md +++ b/README.md @@ -169,7 +169,10 @@ CrewForm is the **first platform with native support for all three agentic proto 📊
Analytics
Track tokens, costs, and agent performance - + +⌨️
CLI Tool
npx crewform — run agents from the terminal + + @@ -224,6 +227,35 @@ Deploy the CrewForm task runner with a single click: You'll need to provide your own Supabase credentials and LLM API keys after deployment. +### CLI (No Server Required) + +Run agents directly from your terminal — no browser, no Supabase, no Docker: + +```bash +# Create an agent config +npx crewform init + +# Run it (defaults to Ollama; or set OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.) +npx crewform run agent.json "Summarise the latest AI news" + +# Interactive chat +npx crewform chat agent.json + +# Run a multi-agent pipeline team +npx crewform init --team +npx crewform run team.json "Research and write about GraphQL" + +# Connect to MCP servers +npx crewform run agent.json --mcp servers.json "Query my database" + +# Connect to your CrewForm workspace +npx crewform login +npx crewform agents +npx crewform pull +``` + +> 📖 See the full [CLI Guide](cli/README.md) for all 12 commands, config formats, and platform integration. + ## Table of Contents - [Protocols & Standards](#-protocols--standards) @@ -394,6 +426,7 @@ CrewForm uses an **open-core** model: a free Community Edition under AGPL-3.0 an | [Chat Widget](https://docs.crewform.tech/chat-widget) | Embed agents on any website with a script tag | | [Observability](https://docs.crewform.tech/observability) | OpenTelemetry + Langfuse tracing setup | | [Workflow Templates](https://docs.crewform.tech/workflow-templates) | Create, install, and share reusable workflow blueprints | +| [CLI Tool](cli/README.md) | Run agents from the terminal with `npx crewform` | | [Changelog](https://docs.crewform.tech/changelog) | Release notes and version history | ## Architecture