Skip to content

Commit f92dd5d

Browse files
committed
Update Pipelex, cleanup, changelog and bump
1 parent b3cea10 commit f92dd5d

14 files changed

Lines changed: 103 additions & 112 deletions

File tree

.pipelex/pipelex.toml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,4 @@ page_output_text_file_name = "page_text.md"
2020
[pipelex.feature_config]
2121
# WIP/Experimental feature flags
2222
is_pipeline_tracking_enabled = false
23-
is_activity_tracking_enabled = false
2423
is_reporting_enabled = true
25-

.pipelex/telemetry.toml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
####################################################################################################
2+
# Pipelex Telemetry Configuration
3+
####################################################################################################
4+
#
5+
# This file controls telemetry settings for Pipelex usage analytics.
6+
# Telemetry helps us improve Pipelex by understanding how it's used.
7+
#
8+
# Documentation: https://docs.pipelex.com
9+
# Support: https://go.pipelex.com/discord
10+
#
11+
####################################################################################################
12+
13+
telemetry_mode = "off" # Values: "off" | "anonymous" | "identified"
14+
host = "https://eu.i.posthog.com"
15+
project_api_key = "phc_HPJnNKpIXh0SxNDYyTAyUtnq9KxNNZJWQszynsWVx4Y"
16+
respect_dnt = true
17+
redact = ["prompt", "system_prompt", "response", "file_path", "url"]
18+
geoip_enabled = true
19+
dry_mode_enabled = false
20+
verbose_enabled = false
21+
user_id = ""

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Changelog
22

3+
## [v0.5.0] - 2025-10-27
4+
5+
- Bump `pipelex` to `v0.14.0`: See `Pipelex` changelog [here](https://docs.pipelex.com/changelog/)
6+
7+
### Changed
8+
- Documentation Improvements: Overhauled `README.md` with a new "Get Your API Keys" section outlining three configuration methods (free `PIPELEX_API_KEY`, bring-your-own provider keys, or local AI models). Updated terminology from "AI-powered pipelines" to "AI-powered workflows".
9+
10+
### Removed
11+
- Removed unused `is_activity_tracking_enabled` option from `pipelex.toml` configuration files.
12+
- Removed `reportConstantRedescription` and `reportShadowedImports` linter rules from `pyproject.toml`.
13+
314
## [v0.4.0] - 2025-10-21
415

516
### Added

README.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
*Cocode is the friend of your code*
44

5-
Cocode is a powerful command-line tool for analyzing and processing code repositories. It converts repository structures and contents into text formats, extracts code interfaces, and performs software engineering analysis using **AI-powered pipelines** using [Pipelex](https://github.com/Pipelex/pipelex).
5+
Cocode is a powerful command-line tool for analyzing and processing code repositories. It converts repository structures and contents into text formats, extracts code interfaces, and performs software engineering analysis using **AI-powered workflows** using [Pipelex](https://github.com/Pipelex/pipelex).
66

77
<h3 align="center">Cocode demo</h3>
88
<p align="center">
@@ -25,18 +25,42 @@ pip install cocode
2525

2626
Important: the current version of Cocode only works when run from the cocode directory.
2727

28+
## 🔑 Get Your API Keys
29+
30+
Cocode's built-in AI workflows require access to AI models. To use the main features (changelog generation, documentation updates, proofreading), you need API keys for:
31+
32+
- **Claude models** (Anthropic) - Required for changelog generation and documentation analysis
33+
- **Gemini models** (Google) - Required for documentation proofreading
34+
35+
You have several options:
36+
37+
### Option 1: Free Pipelex API Key (Free)
38+
Get free access to all models with a single API key:
39+
- Join our [Discord community](https://go.pipelex.com/discord)
40+
- Request your **free API key** (no credit card required) in the [🔑・free-api-key](https://discord.com/channels/1369447918955921449/1418228010431025233) channel
41+
- Add it to your `.env` file: `PIPELEX_API_KEY=your-key-here`
42+
43+
### Option 2: Bring Your Own API Keys
44+
Use your own API keys from AI providers:
45+
46+
**Required for core features:**
47+
- Claude models - Use either:
48+
- `ANTHROPIC_API_KEY` - Direct Anthropic API ([Get key](https://console.anthropic.com/))
49+
- Amazon Bedrock - AWS credentials for Claude via Bedrock ([Setup guide](https://docs.pipelex.com/pages/configuration/config-technical/inference-backend-config/))
50+
- Google Cloud credentials - For Gemini models ([Setup guide](https://docs.pipelex.com/pages/build-reliable-ai-workflows-with-pipelex/ai-plugins-for-multi-llm-workflows/#4-google-vertex-ai-configuration))
51+
52+
Add these to your environment variables or in your `.env` file in your project root.
53+
54+
### Option 3: Local AI
55+
You can also use local models with Ollama, vLLM, or any OpenAI-compatible endpoint. See the [Pipelex configuration guide](https://docs.pipelex.com/pages/setup/configure-ai-providers/) for details.
56+
2857
## ✅ Validation
2958

3059
```bash
3160
# Verify setup and pipelines
3261
cocode validate
3362
```
3463

35-
### Set up environment variables
36-
37-
Enter your API keys into your `.env` file. The `OPENAI_API_KEY` is enough to get you started, but some pipelines require models from other providers.
38-
Some complex pipelines require GCP credentials (See [GCP credentials](https://docs.pipelex.com/pages/build-reliable-ai-workflows-with-pipelex/ai-plugins-for-multi-llm-workflows/#4-google-vertex-ai-configuration) for more details), or Anthropic API keys `ANTHROPIC_API_KEY`.
39-
4064
## 🛠️ Quick Start
4165

4266
### Automatic Documentation & Release Features
@@ -45,10 +69,10 @@ Some complex pipelines require GCP credentials (See [GCP credentials](https://do
4569
cocode doc update v1.0.0 path/to/your/local/repository
4670

4771
# Proofread documentation against codebase
48-
cocode doc proofread --doc-dir docs path/to/your/local/repository # Requires GCP credentials for Gemini
72+
cocode doc proofread --doc-dir docs path/to/your/local/repository
4973

5074
# Generate changelog from version diff
51-
cocode changelog update v1.0.0 path/to/your/local/repository # Requires Anthropic API key for claude
75+
cocode changelog update v1.0.0 path/to/your/local/repository
5276

5377
# Update AI instructions (AGENTS.md, CLAUDE.md, cursor rules) based on code changes
5478
cocode ai_instructions update v1.0.0 path/to/your/local/repository

cocode/cli/analyze/analyze_cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
import typer
99
from pipelex.hub import get_pipeline_tracker
10-
from pipelex.pipe_run.pipe_run_params import PipeRunMode
10+
from pipelex.pipe_run.pipe_run_mode import PipeRunMode
1111
from pipelex.tools.misc.file_utils import load_text_from_path
1212

1313
from cocode.common import get_output_dir, validate_repo_path

cocode/cli/changelog/changelog_cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
import typer
99
from pipelex.hub import get_pipeline_tracker
10-
from pipelex.pipe_run.pipe_run_params import PipeRunMode
10+
from pipelex.pipe_run.pipe_run_mode import PipeRunMode
1111

1212
from cocode.common import get_output_dir, validate_repo_path
1313
from cocode.swe.swe_cmd import swe_from_repo_diff

cocode/cli/features/features_cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from typing import Annotated, Optional
77

88
import typer
9-
from pipelex.pipe_run.pipe_run_params import PipeRunMode
9+
from pipelex.pipe_run.pipe_run_mode import PipeRunMode
1010

1111
from cocode.common import PipeCode, get_output_dir
1212
from cocode.swe.swe_cmd import swe_from_file

cocode/cli/repo/repo_cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from typing import Annotated, List, Optional
77

88
import typer
9-
from pipelex.pipe_run.pipe_run_params import PipeRunMode
9+
from pipelex.pipe_run.pipe_run_mode import PipeRunMode
1010

1111
from cocode.common import PipeCode, get_output_dir, validate_repo_path
1212
from cocode.repox.models import OutputStyle

cocode/pipelines/swe_diff/write_changelog.plx

Lines changed: 0 additions & 87 deletions
This file was deleted.

cocode/swe/swe_cmd.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
from pipelex.core.stuffs.list_content import ListContent
99
from pipelex.core.stuffs.stuff_factory import StuffFactory
1010
from pipelex.hub import get_report_delegate, get_required_concept
11-
from pipelex.pipe_run.pipe_run_params import PipeRunMode
11+
from pipelex.pipe_run.pipe_run_mode import PipeRunMode
1212
from pipelex.pipeline.execute import execute_pipeline
1313
from pipelex.tools.misc.file_utils import ensure_path, failable_load_text_from_path, load_text_from_path, save_text_to_path
1414

0 commit comments

Comments
 (0)