Build AI methods with your coding agent, then run them anywhere: as an MCP for chatbots, as a webapp for people, or via API for your software.
Update docs & Makefile for changes in cli commands
Louis Choquelb1e5b74c852b
diff --git a/AGENTS.md b/AGENTS.mdindex 50a542992..71e3063d5 100644--- a/AGENTS.md+++ b/AGENTS.md@@ -30,7 +30,7 @@ This python >=3.10 code is in the `pipelex` directory.## Testing- Always test with `make codex-tests` -> it runs pytest on our `tests/` directory using proper settings-- If all unit tests pass, run `make validate` -> it runs a minimal version of our app with just the inits and data loading+- If all unit tests pass, run `make validate` -> it runs a minimal version of our app with just the inits and data loading (`pipelex validate all` under the hood)## PR Instructionsdiff --git a/CHANGELOG.md b/CHANGELOG.mdindex 8e1643302..18d451f9d 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -156,7 +156,7 @@ Simplified input memory:### Documentation & Development Experience- **Cursor Rules Enhancement**: Comprehensive pipe controller documentation covering `PipeSequence`, `PipeCondition`, `PipeBatch`, and `PipeParallel`, improved PipeOperator documentation for `PipeLLM`, `PipeOCR`-- **Pipeline Validation CLI**: Enhanced `pipelex validate` command with better error reporting and validation coverage+- **Pipeline Validation CLI**: Enhanced `pipelex validate all` command with better error reporting and validation coverage- **Improved Error Messages**: Better formatting and context for pipeline configuration errors### Changed@@ -473,7 +473,7 @@ is_reporting_enabled = true- Use a minimum version for `uv` instead of a fixed version- Implement `AGENTS.md` for Codex- Add tests for some of the `tools.misc`-- pipelex cli: Rename `pipelex run-setup` to `pipelex validate`+- pipelex cli: Rename `pipelex run-setup` to `pipelex validate all`## [v0.2.8] - 2025-05-28diff --git a/CLAUDE.md b/CLAUDE.mdindex ed571e800..2a57cb258 100644--- a/CLAUDE.md+++ b/CLAUDE.md@@ -82,7 +82,7 @@ class TestFooBar:- Always test with `make t` -> it runs pytest using proper settings- If some pytest tests fail, run pytest on the failed ones with the required verbosity to diagnose the issue-- If all unit tests pass, run `make validate` -> it runs a minimal version of our app with just the inits and data loading+- If all unit tests pass, run `make validate` -> it runs a minimal version of our app with just the inits and data loading (`pipelex validate all` under the hood)## PR Instructionsdiff --git a/Makefile b/Makefileindex 19525ecfd..eb179713e 100644--- a/Makefile+++ b/Makefile@@ -153,7 +153,7 @@ update: envvalidate: env$(call PRINT_TITLE,"Running setup sequence")- $(VENV_PIPELEX) validate -c pipelex/libraries+ $(VENV_PIPELEX) validate all -c pipelex/librariesbuild: env$(call PRINT_TITLE,"Building the wheels")diff --git a/docs/pages/configuration/config-technical/library-config.md b/docs/pages/configuration/config-technical/library-config.mdindex e621067ec..633ea7850 100644--- a/docs/pages/configuration/config-technical/library-config.md+++ b/docs/pages/configuration/config-technical/library-config.md@@ -61,7 +61,7 @@ exported_templates_path = "pipelex_libraries/templates"Use the CLI command to initialize libraries:```bash-pipelex init-libraries+pipelex init libraries```This will:@@ -122,7 +122,7 @@ The library system includes specific error types:2. **Validation**:- - Run `pipelex validate` after making changes+ - Run `pipelex validate all` after making changes- Check for domain consistency- Verify concept relationshipsdiff --git a/docs/pages/configuration/index.md b/docs/pages/configuration/index.mdindex 714539c88..9e8cab9df 100644--- a/docs/pages/configuration/index.md+++ b/docs/pages/configuration/index.md@@ -5,13 +5,13 @@Pipelex uses a TOML-based configuration system. The main configuration file `pipelex.toml` must be located at the root of your project. You can create this file by running:```bash-pipelex init-config+pipelex init config```💡 **Important Notes**:-1. `pipelex init-config` creates a **template** configuration file with sample settings. It does not include all possible configuration options - it's meant as a starting point.-2. Using `pipelex init-config --reset` will **overwrite** your existing `pipelex.toml` file without warning. Make sure to backup your configuration before using this flag.+1. `pipelex init config` creates a **template** configuration file with sample settings. It does not include all possible configuration options - it's meant as a starting point.+2. Using `pipelex init config --reset` will **overwrite** your existing `pipelex.toml` file without warning. Make sure to backup your configuration before using this flag.For a complete list of all possible configuration options, refer to the configuration group documentation below.@@ -69,5 +69,5 @@ NB: The run_mode unit_test is used for testing purposes.1. **Version Control**: Include your base `pipelex.toml` in version control2. **Environment Overrides**: Use environment-specific files for sensitive or environment-dependent settings3. **Documentation**: Comment any custom settings for team reference-4. **Validation**: Run `pipelex validate` after making configuration changes+4. **Validation**: Run `pipelex validate all` after making configuration changes5. **Gitignore**: Add local and sensitive override files to `.gitignore`diff --git a/docs/pages/installation/index.md b/docs/pages/installation/index.mdindex b2ee24c26..183ed10ef 100644--- a/docs/pages/installation/index.md+++ b/docs/pages/installation/index.md@@ -40,7 +40,7 @@ All the secret keys used by `pipelex` are specified in the `.env.example` file.In order to set the pipelex configuration files, you need to run 2 commands using the CLI (we recommend to run it at the root of your project):-- `pipelex init-libraries`: This will create a `pipelex_libraries` folder, with the base llm configuration and the base pipelines.+- `pipelex init libraries`: This will create a `pipelex_libraries` folder, with the base llm configuration and the base pipelines.This is the directory where you should add your pipelines.The structure is like this:@@ -58,7 +58,7 @@ The structure is like this:Learn more about pipelex_libraries in our [Libraries documentation](../build-reliable-ai-workflows-with-pipelex/kick-off-a-knowledge-pipeline-project.md)-- `pipelex init-config`: This cli command will create a `pipelex.toml` file at the root of the project, with basic configuration. This configuration file gathers all configuration for feature flags, logging, cost reporting, and so on... Learn more in our [Configuration documentation](../configuration/index.md)+- `pipelex init config`: This cli command will create a `pipelex.toml` file at the root of the project, with basic configuration. This configuration file gathers all configuration for feature flags, logging, cost reporting, and so on... Learn more in our [Configuration documentation](../configuration/index.md)💡 _Any troubles? Have a look at our [Cookbook](https://github.com/Pipelex/pipelex-cookbook)! and come ask for help on our [Discord](https://go.pipelex.com/discord)_diff --git a/docs/pages/quick-start/index.md b/docs/pages/quick-start/index.mdindex a447a4020..4da126632 100644--- a/docs/pages/quick-start/index.md+++ b/docs/pages/quick-start/index.md@@ -14,7 +14,7 @@ For illustration purposes, let's build **a character generator**. Each example r### Write your first pipelineFirst, create a `.toml` library file in the `pipelex_libraries/pipelines` directory to store your pipe definition.-Run `pipelex init-libraries` to create this directory if it doesn't exist. For now, keep all your pipeline definitions inside that folder only.+Run `pipelex init libraries` to create this directory if it doesn't exist. For now, keep all your pipeline definitions inside that folder only.`character.toml````tomldiff --git a/docs/pages/tools/cli.md b/docs/pages/tools/cli.mdindex 15fb31849..2fe5e781b 100644--- a/docs/pages/tools/cli.md+++ b/docs/pages/tools/cli.md@@ -4,76 +4,47 @@ The Pipelex CLI provides a command-line interface for managing and interacting w## Available Commands-### `pipelex init-libraries`+### Init group-Initialize Pipelex libraries in the current directory.+Initialize project assets.```bash-pipelex init-libraries [--overwrite/-o]+pipelex init libraries [DIRECTORY] [--overwrite/-o]+pipelex init config [--reset/-r]```-**Options:**-- `--overwrite`, `-o`: If set, existing library files will be overwritten. Otherwise, only missing files will be created.+### Validate group-### `pipelex init-config`--Initialize Pipelex configuration in the current directory.--```bash-pipelex init-config [--reset/-r]-```--**Options:**-- `--reset`, `-r`: If set, existing configuration file (pipelex.toml) will be overwritten. Otherwise, the command will warn if the file already exists.--### `pipelex validate`--Run the setup sequence to validate your Pipelex configuration and pipelines.+Validate configuration and pipelines.```bash-pipelex validate+pipelex validate all [-c/--config-folder-path PATH]+pipelex validate pipe PIPE_CODE [-c/--config-folder-path PATH]```-This command:+### Show group-1. Exports libraries-2. Validates the configuration-3. Ensures all pipelines are properly set up--### `pipelex show-config`--Display the current Pipelex configuration.+Inspect configuration and pipes.```bash-pipelex show-config+pipelex show config+pipelex show pipes [-c/--config-folder-path PATH]+pipelex show pipe PIPE_CODE [-c/--config-folder-path PATH]```-Shows the complete configuration for your project, including all settings and parameters.-See more in our [Configuration documentation](../configuration/index.md)+### Migrate group-### `pipelex list-pipes`--List all available pipes in your project.+Migrate TOML files to the new syntax.```bash-pipelex list-pipes+pipelex migrate run [-c/--config-folder-path PATH] [--dry-run] [--backups/--no-backups]```-Displays a table of pipes organized by domain, showing:--- Code: The unique identifier for each pipe-- Definition: Description of the pipe's purpose-- Input: Required input parameters and their concept codes-- Output: The output concept code--The output is formatted as tables grouped by domain, with concept codes simplified when they belong to the current domain.-## Usage Tips-1. Always run `pipelex validate` after making changes to your configuration or pipelines-2. Use `pipelex show-config` to debug configuration issues+1. Always run `pipelex validate all` after making changes to your configuration or pipelines+2. Use `pipelex show config` to debug configuration issues3. When initializing a new project:-- - Start with `pipelex init-config`- - Then run `pipelex init-libraries`- - Finally, validate your setup with `pipelex validate`+ - Start with `pipelex init config`+ - Then run `pipelex init libraries`+ - Finally, validate your setup with `pipelex validate all`diff --git a/docs/pages/tools/migration.md b/docs/pages/tools/migration.mdindex 21927e078..1aa32ef52 100644--- a/docs/pages/tools/migration.md+++ b/docs/pages/tools/migration.md@@ -57,7 +57,7 @@ If you prefer to migrate manually or need to handle special cases:1. **Locate your TOML files**: Find all pipeline library files (typically in your configured pipelines directory)2. **Update concept definitions**: Change `Concept =` to `definition =` in all `[concept.ConceptName]` sections-3. **Validate syntax**: Run `pipelex validate` to ensure your files are correctly formatted+3. **Validate syntax**: Run `pipelex validate all` to ensure your files are correctly formatted### Examples@@ -101,7 +101,7 @@ After migration, validate your pipeline files:```bash# Validate all pipeline files-pipelex validate+pipelex validate all# Run a specific pipeline to testpipelex run your-pipeline-name@@ -185,7 +185,7 @@ If you prefer to migrate manually:- Replace `PipeClassName = "description"` with:- `type = "PipeClassName"`- `definition = "description"`-3. **Validate syntax**: Run `pipelex validate` to ensure your files are correctly formatted+3. **Validate syntax**: Run `pipelex validate all` to ensure your files are correctly formatted### Examples@@ -247,7 +247,7 @@ After migration, validate your pipeline files:```bash# Validate all pipeline files-pipelex validate+pipelex validate all# Run a specific pipeline to testpipelex run your-pipeline-namediff --git a/pipelex/cli/commands/migrate_cmd.py b/pipelex/cli/commands/migrate_cmd.pyindex 1ddbf42c5..bcb8b442c 100644--- a/pipelex/cli/commands/migrate_cmd.py+++ b/pipelex/cli/commands/migrate_cmd.py@@ -74,7 +74,7 @@ def do_migrate(typer.echo(f"\n✅ Migration completed: {result.total_changes} change(s) applied to {result.files_modified} file(s)")if create_backups:typer.echo(" Backup files created with .backup extension")- typer.echo(" Run 'pipelex validate' to verify the migration")+ typer.echo(" Run 'pipelex validate all' to verify the migration")except FileNotFoundError as exc:typer.echo(f"❌ {exc}")raise typer.Exit(1)