Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
"program": "${workspaceFolder}/.venv/bin/pipelex",
"args": [
"validate",
"temp/bundle.plx",
"temp/bundle.mthds",
],
"console": "integratedTerminal",
"justMyCode": false
Expand All @@ -99,7 +99,7 @@
"program": "${workspaceFolder}/.venv/bin/pipelex",
"args": [
"run",
"tests/integration/pipelex/pipes/pipelines/test_image_out_in.plx",
"tests/integration/pipelex/pipes/pipelines/test_image_out_in.mthds",
],
"console": "integratedTerminal",
"justMyCode": false
Expand All @@ -111,7 +111,7 @@
"program": "${workspaceFolder}/.venv/bin/pipelex",
"args": [
"run",
"tests/integration/pipelex/pipes/pipelines/test_image_out_in.plx",
"tests/integration/pipelex/pipes/pipelines/test_image_out_in.mthds",
"--pipe",
"describe_image",
"--inputs",
Expand Down
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"python.testing.pytestEnabled": true,
"djlint.showInstallError": false,
"files.associations": {
"*.plx": "plx"
"*.mthds": "mthds"
},
"editor.formatOnSave": true,
"[html]": {
Expand Down
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ NEVER EVER put more than one TestClass into a test module.
- Place test files in the appropriate test category directory:
- `tests/unit/` - for unit tests that test individual functions/classes in isolation
- `tests/integration/` - for integration tests that test component interactions
- `tests/e2e/` - for end-to-end tests that test complete workflows
- `tests/e2e/` - for end-to-end tests that test complete methods
- Do NOT add `__init__.py` files to test directories. Test directories do not need to be Python packages.
- Fixtures are defined in conftest.py modules at different levels of the hierarchy, their scope is handled by pytest
- Test data is placed inside test_data.py at different levels of the hierarchy, they must be imported with package paths from the root like `from tests.integration.pipelex.cogt.test_data`. Their content is all constants, regrouped inside classes to keep things tidy.
Expand Down
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
<br/>
<br/>

<h2 align="center">AI Workflows That Agents Build & Run</h2>
<p align="center">Pipelex is developing the open standard for repeatable AI workflows.<br/>
<h2 align="center">AI Methods That Agents Build & Run</h2>
<p align="center">Pipelex is developing the open standard for repeatable AI methods.<br/>
Write business logic, not API calls.</p>

<div>
Expand Down Expand Up @@ -76,17 +76,17 @@ Use your existing API keys from OpenAI, Anthropic, Google, Mistral, etc. See [Co
<!-- PRERELEASE_LINK -->
Run models locally with Ollama, vLLM, LM Studio, or llama.cpp - no API keys required. See [Configure AI Providers](https://docs.pipelex.com/pre-release/home/5-setup/configure-ai-providers/) for details.

## 3. Generate Your First Workflow
## 3. Generate Your First Method

Create a complete AI workflow with a single command:
Create a complete AI method with a single command:

```bash
pipelex build pipe "Take a CV and Job offer in PDF, analyze if they match and generate 5 questions for the interview" --output results/cv_match.plx
pipelex build pipe "Take a CV and Job offer in PDF, analyze if they match and generate 5 questions for the interview" --output results/cv_match.mthds
```

This command generates a production-ready `.plx` file with domain definitions, concepts, and multiple processing steps that analyzes CV-job fit and prepares interview questions.
This command generates a production-ready `.mthds` file with domain definitions, concepts, and multiple processing steps that analyzes CV-job fit and prepares interview questions.

**cv_match.plx**
**cv_match.mthds**
```toml
domain = "cv_match"
description = "Matching CVs with job offers and generating interview questions"
Expand All @@ -109,7 +109,7 @@ refines = "Text"
[pipe.analyze_cv_job_match_and_generate_questions]
type = "PipeSequence"
description = """
Main pipeline that orchestrates the complete CV-job matching and interview question generation workflow. Takes a candidate's CV and a job offer as PDF documents, extracts their content, performs a comprehensive match analysis identifying strengths, gaps, and areas to probe, and generates exactly 5 targeted interview questions based on the analysis results.
Main pipeline that orchestrates the complete CV-job matching and interview question generation method. Takes a candidate's CV and a job offer as PDF documents, extracts their content, performs a comprehensive match analysis identifying strengths, gaps, and areas to probe, and generates exactly 5 targeted interview questions based on the analysis results.
"""
inputs = { cv_pdf = "PDF", job_offer_pdf = "PDF" }
output = "Question[5]"
Expand Down Expand Up @@ -255,7 +255,7 @@ flowchart TD

```bash
# Run with input file
pipelex run results/cv_match.plx --inputs inputs.json
pipelex run results/cv_match.mthds --inputs inputs.json
```

Create an `inputs.json` file with your PDF URLs:
Expand Down Expand Up @@ -305,13 +305,13 @@ asyncio.run(run_pipeline())
<table align="center">
<tr>
<td align="center" width="50%">
<h3>From Whiteboard to AI Workflow in less than 5 minutes with no hands (2025-07)</h3>
<h3>From Whiteboard to AI Method in less than 5 minutes with no hands (2025-07)</h3>
<a href="https://go.pipelex.com/demo">
<img src="https://go.pipelex.com/demo-thumbnail" alt="Pipelex Demo" width="100%" style="max-width: 500px; height: auto;">
</a>
</td>
<td align="center" width="50%">
<h3>The AI workflow that writes an AI workflow in 64 seconds (2025-09)</h3>
<h3>The AI method that writes an AI method in 64 seconds (2025-09)</h3>
<a href="https://go.pipelex.com/Demo-Live">
<img src="https://d2cinlfp2qnig1.cloudfront.net/banners/pipelex_play_video_demo_live.jpg" alt="Pipelex Live Demo" width="100%" style="max-width: 500px; height: auto;">
</a>
Expand All @@ -323,21 +323,21 @@ asyncio.run(run_pipeline())

## 💡 What is Pipelex?

Pipelex is an open-source language that enables you to build and run **repeatable AI workflows**. Instead of cramming everything into one complex prompt, you break tasks into focused steps, each pipe handling one clear transformation.
Pipelex is an open-source language that enables you to build and run **repeatable AI methods**. Instead of cramming everything into one complex prompt, you break tasks into focused steps, each pipe handling one clear transformation.

Each pipe processes information using **Concepts** (typing with meaning) to ensure your pipelines make sense. The Pipelex language (`.plx` files) is simple and human-readable, even for non-technical users. Each step can be structured and validated, giving you the reliability of software with the intelligence of AI.
Each pipe processes information using **Concepts** (typing with meaning) to ensure your pipelines make sense. The Pipelex language (`.mthds` files) is simple and human-readable, even for non-technical users. Each step can be structured and validated, giving you the reliability of software with the intelligence of AI.

## 📖 Next Steps

<!-- PRERELEASE_LINK -->
**Learn More:**
- [Design and Run Pipelines](https://docs.pipelex.com/pre-release/home/6-build-reliable-ai-workflows/pipes/) - Complete guide with examples
- [Kick off a Pipeline Project](https://docs.pipelex.com/pre-release/home/6-build-reliable-ai-workflows/kick-off-a-pipelex-workflow-project/) - Deep dive into Pipelex
- [Design and Run Methods](https://docs.pipelex.com/pre-release/home/6-build-reliable-ai-workflows/pipes/) - Complete guide with examples
- [Kick off a Method Project](https://docs.pipelex.com/pre-release/home/6-build-reliable-ai-workflows/kick-off-a-methods-project/) - Deep dive into Pipelex
- [Configure AI Providers](https://docs.pipelex.com/pre-release/home/5-setup/configure-ai-providers/) - Set up AI providers and models

## 🔧 IDE Extension

We **highly** recommend installing our extension for `.plx` files into your IDE. You can find it in the [Open VSX Registry](https://open-vsx.org/extension/Pipelex/pipelex). It's coming soon to VS Code marketplace too. If you're using Cursor, Windsurf or another VS Code fork, you can search for it directly in your extensions tab.
We **highly** recommend installing our extension for `.mthds` files into your IDE. You can find it in the [Open VSX Registry](https://open-vsx.org/extension/Pipelex/pipelex). It's coming soon to VS Code marketplace too. If you're using Cursor, Windsurf or another VS Code fork, you can search for it directly in your extensions tab.

## 📚 Examples & Cookbook

Expand Down
12 changes: 6 additions & 6 deletions docs/home/1-releases/chicago.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ title: "Chicago Release"

# Pipelex v0.18.0 "Chicago"

**The AI workflow framework that just works.**
**The AI method framework that just works.**

## Why Pipelex

Pipelex eliminates the complexity of building AI-powered applications. Instead of managing multiple SDKs, API configurations, and infrastructure concerns, developers focus on what matters: their application logic.

- **One framework** for prompts, pipelines, and structured outputs
- **One API key** for dozens of AI models
- **One workflow** from prototype to production
- **One method** from prototype to production

---

## A Major Milestone

Three months after our first public launch in San Francisco, Pipelex reaches a new level of maturity with the "Chicago" release (currently in beta-test). This version delivers on our core promise: **enabling every developer to build AI workflows that are reliable, flexible, and production-ready**.
Three months after our first public launch in San Francisco, Pipelex reaches a new level of maturity with the "Chicago" release (currently in beta-test). This version delivers on our core promise: **enabling every developer to build AI methods that are reliable, flexible, and production-ready**.

Version 0.18.0 represents our most significant release to date, addressing the three priorities that emerged from real-world usage:

- **Universal model access** — one API key for all leading AI models
- **State-of-the-art document extraction** — deployable anywhere
- **Visual pipeline inspection** — full transparency into your workflows
- **Visual pipeline inspection** — full transparency into your methods

---

Expand Down Expand Up @@ -91,7 +91,7 @@ Broad support for open-source AI:

### Developer Experience

- **Pure PLX Workflows** — Inline concept structures now support nested concepts, making Pipelex fully usable with just `.plx` files and the CLI—no Python code required
- **Pure MTHDS Methods** — Inline concept structures now support nested concepts, making Pipelex fully usable with just `.mthds` files and the CLI—no Python code required
- **Deep Integration Options** — Generate Pydantic BaseModels from your declarative concepts for full IDE autocomplete, type checking, and validation (TypeScript Zod structures coming soon)
- **PipeCompose Construct Mode** — Build `StructuredContent` objects deterministically without an LLM, composing outputs from working memory variables, fixed values, templates, and nested structures
- **Cloud Storage for Artifacts** — Store generated images and extracted pages on AWS S3 or Google Cloud Storage with public or signed URLs
Expand All @@ -112,7 +112,7 @@ Then run `pipelex init` to configure your environment and obtain your Gateway AP

---

*Ready to build AI workflows that just work?*
*Ready to build AI methods that just work?*

[Join the Waitlist](https://go.pipelex.com/waitlist){ .md-button .md-button--primary }
[Documentation](https://docs.pipelex.com/pre-release){ .md-button }
Original file line number Diff line number Diff line change
Expand Up @@ -216,4 +216,4 @@ def setup_pipelex():
return pipelex_instance
```

The observer system provides powerful insights into your pipeline execution patterns and is essential for monitoring, debugging, and optimizing your Pipelex workflows.
The observer system provides powerful insights into your pipeline execution patterns and is essential for monitoring, debugging, and optimizing your Pipelex methods.
24 changes: 12 additions & 12 deletions docs/home/2-get-started/pipe-builder.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Generate Workflows with Pipe Builder"
title: "Generate Methods with Pipe Builder"
---

![Pipelex Banner](https://d2cinlfp2qnig1.cloudfront.net/banners/pipelex_banner_docs_v2.png)
Expand All @@ -18,22 +18,22 @@ During the second step of the initialization, we recommand, for a quick start, t

If you want to bring your own API keys, see [Configure AI Providers](../../home/5-setup/configure-ai-providers.md) for details.

# Generate workflows with Pipe Builder
# Generate methods with Pipe Builder

The fastest way to create production-ready AI workflows is with the Pipe Builder. Just describe what you want, and Pipelex generates complete, validated pipelines.
The fastest way to create production-ready AI methods is with the Pipe Builder. Just describe what you want, and Pipelex generates complete, validated pipelines.

```bash
pipelex build pipe "Take a CV and Job offer in PDF, analyze if they match and generate 5 questions for the interview"
```

The pipe builder generates three files in a numbered directory (e.g., `results/pipeline_01/`):

1. **`bundle.plx`** - Complete production-ready script in our Pipelex language with domain definition, concepts, and pipe steps
1. **`bundle.mthds`** - Complete production-ready script in our Pipelex language with domain definition, concepts, and pipe steps
2. **`inputs.json`** - Template describing the **mandatory** inputs for running the pipe
3. **`run_{pipe_code}.py`** - Ready-to-run Python script that you can customize and execute

!!! tip "Pipe Builder Requirements"
For now, the pipe builder requires access to **Claude 4.5 Sonnet**, either through Pipelex Inference, or using your own key through Anthropic, Amazon Bedrock or BlackboxAI. Don't hesitate to join our [Discord](https://go.pipelex.com/discord) to get a key, otherwise, you can also create the workflows yourself, following our [documentation guide](./write-workflows-manually.md).
For now, the pipe builder requires access to **Claude 4.5 Sonnet**, either through Pipelex Inference, or using your own key through Anthropic, Amazon Bedrock or BlackboxAI. Don't hesitate to join our [Discord](https://go.pipelex.com/discord) to get a key, otherwise, you can also create the methods yourself, following our [documentation guide](./write-methods-manually.md).

!!! info "Learn More"
Want to understand how the Pipe Builder works under the hood? See [Pipe Builder Deep Dive](../9-tools/pipe-builder.md) for the full explanation of its multi-step generation process.
Expand All @@ -43,14 +43,14 @@ The pipe builder generates three files in a numbered directory (e.g., `results/p
**Option 1: CLI**

```bash
pipelex run results/cv_match.plx --inputs inputs.json
pipelex run results/cv_match.mthds --inputs inputs.json
```

The `--inputs` file should be a JSON dictionary where keys are input variable names and values are the input data. Learn more on how to provide the inputs of a pipe: [Providing Inputs to Pipelines](../../home/6-build-reliable-ai-workflows/pipes/provide-inputs.md)

**Option 2: Python**

This requires having the `.plx` file or your pipe inside the directory where the Python file is located.
This requires having the `.mthds` file or your pipe inside the directory where the Python file is located.

```python
import json
Expand All @@ -76,7 +76,7 @@ print(pipe_output.main_stuff)

## IDE Support

We **highly** recommend installing our own extension for PLX files into your IDE of choice. You can find it in the [Open VSX Registry](https://open-vsx.org/extension/Pipelex/pipelex) and download it directly using [this link](https://open-vsx.org/api/Pipelex/pipelex/0.2.1/file/Pipelex.pipelex-0.2.1.vsix). It's coming soon to the VS Code marketplace too and if you are using Cursor, Windsurf or another VS Code fork, you can search for it directly in your extensions tab.
We **highly** recommend installing our own extension for MTHDS files into your IDE of choice. You can find it in the [Open VSX Registry](https://open-vsx.org/extension/Pipelex/pipelex) and download it directly using [this link](https://open-vsx.org/api/Pipelex/pipelex/0.2.1/file/Pipelex.pipelex-0.2.1.vsix). It's coming soon to the VS Code marketplace too and if you are using Cursor, Windsurf or another VS Code fork, you can search for it directly in your extensions tab.

## Examples

Expand All @@ -86,12 +86,12 @@ We **highly** recommend installing our own extension for PLX files into your IDE

## Next Steps

Now that you know how to generate workflows with the Pipe Builder, explore these resources:
Now that you know how to generate methods with the Pipe Builder, explore these resources:

**Learn how to Write Workflows yourself**
**Learn how to Write Methods yourself**

- [:material-pencil: Write Workflows Manually](./write-workflows-manually.md){ .md-button .md-button--primary }
- [:material-book-open-variant: Build Reliable AI Workflows](../6-build-reliable-ai-workflows/kick-off-a-pipelex-workflow-project.md){ .md-button .md-button--primary }
- [:material-pencil: Write Methods Manually](./write-methods-manually.md){ .md-button .md-button--primary }
- [:material-book-open-variant: Build Reliable AI Methods](../6-build-reliable-ai-workflows/kick-off-a-methods-project.md){ .md-button .md-button--primary }

**Explore Examples:**

Expand Down
Loading
Loading