Documentation
Everything you need to set up and use FlowEasy — from the dashboard to MCP integration in your IDE.
Getting Started
FlowEasy generates production-grade CI/CD pipelines with built-in DevSecOps gates. Here's how to get started:
API Keys
API keys let you access FlowEasy programmatically — via the MCP server, REST API, or custom integrations.
- Go to Settings → API Keys
- Click "Create New Key" and give it a name (e.g., "Claude Code")
- Copy the key immediately — it won't be shown again
Keys start with fe_ and are stored as SHA-256 hashes. You can have up to 10 active keys.
MCP Server Setup
The FlowEasy MCP server lets you manage pipelines directly from your AI-powered IDE. Install via npx floweasy-mcp.
Claude Code, Cursor, or any MCP-compatible tool
Add to your MCP config file (~/.claude.json for Claude Code, Settings → MCP for Cursor):
{
"mcpServers": {
"floweasy": {
"command": "npx",
"args": ["-y", "floweasy-mcp"],
"env": {
"FLOWEASY_API_KEY": "fe_your_key_here"
}
}
}
}Windsurf
Add to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"floweasy": {
"command": "npx",
"args": ["-y", "floweasy-mcp"],
"env": {
"FLOWEASY_API_KEY": "fe_your_key_here"
}
}
}
}OpenAI Codex
Add to ~/.codex/config.toml:
[mcp_servers.floweasy]
command = "npx"
args = ["-y", "floweasy-mcp"]
[mcp_servers.floweasy.env]
FLOWEASY_API_KEY = "fe_your_key_here"Available Tools
Once connected, your AI assistant has access to these 9 tools:
list_pipelinesList all your pipelines with current status, repo, branch, and schedule.
pipeline_statusGet detailed info on a specific pipeline including enabled gates and last run.
view_logsView the latest CI/CD run logs with job statuses and step details.
pipeline_historyShow the last 20 runs with commit info, actor, and duration.
analyze_failureAI analysis of why a pipeline failed — root cause, category, and suggested fix.
rerun_pipelineRe-run the latest workflow for a pipeline.
rollback_pipelineRollback to the previous successful deployment.
cancel_runCancel an active (running/pending) pipeline run.
compliance_reportGenerate a compliance report with security gates and run statistics (Pro only).
Usage Examples
After setting up the MCP server, just ask your AI assistant naturally:
# Check pipeline status
> "Check my pipeline status"
# Investigate a failure
> "Why did my deploy fail?"
# Take action
> "Re-run my pipeline"
> "Rollback to previous deploy"
> "Cancel the running pipeline"
# History and compliance
> "Show my pipeline history"
> "Generate a compliance report"
Dashboard
The web dashboard at /dashboard gives you full visibility:
- Home — Pipeline list with real-time status, log viewer, re-run, and history
- Insights — Success rate, avg duration, runs breakdown (7-day window)
- Deploys — Full deploy history with commit, actor, and duration
- Projects — Repository cards with aggregated pipeline status
- Runners — GitHub-hosted and self-hosted runner status
- Plan — Current plan, usage, and upgrade options
- Settings — Profile, notifications, API keys, MCP setup
- Support — Create and track support tickets
Plans & Limits
Free
$0 forever
- 1 repository
- 5 pipeline runs / month
- Lint + Tests + Basic SAST
- Vercel deployments
- Community support
Pro
$19 / month
- Unlimited repositories
- 10,000 pipeline runs / month
- All DevSecOps gates (SAST, SCA, Secrets, DAST)
- Auto-Heal AI + Slack/Discord alerts
- SBOM generation + compliance reports
- All deploy targets
- Priority support
Environment Variables (MCP)
| Variable | Required | Description |
|---|---|---|
FLOWEASY_API_KEY | Yes | Your FlowEasy API key (starts with fe_) |
FLOWEASY_BASE_URL | No | Custom base URL (default: production) |