Skip to content

docs: add CLI tool to README — Quick Start, features grid, and docume… #396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vincentgrobler merged 1 commit into from
May 14, 2026
Merged

docs: add CLI tool to README — Quick Start, features grid, and docume… #396

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,10 @@ CrewForm is the **first platform with native support for all three agentic proto
<td align="center" width="25%">
📊<br/><strong>Analytics</strong><br/>Track tokens, costs, and agent performance
</td>
<td colspan="3"></td>
<td align="center" width="25%">
⌨️<br/><strong>CLI Tool</strong><br/><code>npx crewform</code> — run agents from the terminal
</td>
<td colspan="2"></td>
</tr>
</table>

Expand Down Expand Up @@ -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 <agent-id>
```

> 📖 See the full [CLI Guide](cli/README.md) for all 12 commands, config formats, and platform integration.

## Table of Contents

- [Protocols & Standards](#-protocols--standards)
Expand Down Expand Up @@ -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
Expand Down
Loading