This is an automated email from the ASF dual-hosted git repository.
tenthe pushed a commit to branch 4692-deprecate-the-streampipes-cli
in repository https://gitbox.apache.org/repos/asf/streampipes.git
The following commit(s) were added to
refs/heads/4692-deprecate-the-streampipes-cli by this push:
new 14b6bea6a2 docs: deprecate CLI in README docs
14b6bea6a2 is described below
commit 14b6bea6a2ad485f36da7c3be11c2b8cd112ee0d
Author: Philipp Zehnder <[email protected]>
AuthorDate: Tue Jul 7 14:14:43 2026 +0000
docs: deprecate CLI in README docs
---
README.md | 14 ++++++++++++--
installer/cli/README.md | 2 ++
2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 4a55a95fed..f63e50f4b3 100644
--- a/README.md
+++ b/README.md
@@ -90,7 +90,7 @@ As a ready-to-use platform, StreamPipes enables users to
implement industrial Io
The fastest way to get a full installation with extensions is to use one of
the Docker-based installers:
- [StreamPipes Compose](installer/compose) for container-based deployment
-- [StreamPipes CLI](installer/cli) for developers who want to extend
StreamPipes
+- [StreamPipes CLI](installer/cli) for developers who want to extend
StreamPipes (**deprecated**)
- [StreamPipes k8s](installer/k8s) for cluster-based operation
For most first-time users, `installer/compose` is the right starting point.
@@ -104,6 +104,16 @@ After the services are up, open `http://localhost` to
complete the setup in the
### Build StreamPipes as a developer
+> **Deprecated:** The StreamPipes CLI remains available for existing users,
but it is deprecated and will be removed in a future release. For local
development, prefer the dev container setup described below.
+
+#### Dev Container Setup (Experimental)
+
+The repository includes an experimental dev container setup in
[`.devcontainer`](.devcontainer). It starts the required third-party services
with Docker Compose and provides a containerized development environment for
running StreamPipes from source.
+
+For users not using VS Code, the dev container files can still serve as the
reference setup for the required development services and environment
variables. See
[`.devcontainer/docker-compose.yml`](.devcontainer/docker-compose.yml),
[`.devcontainer/.env.example`](.devcontainer/.env.example), and
[`.devcontainer/README.md`](.devcontainer/README.md) for the current Compose
configuration.
+
+For VS Code users, open the repository in VS Code and run `Dev Containers:
Reopen in Container`. After the container has started, use the included VS Code
tasks or debug launch configurations to start the core, extensions, and UI.
+
Prerequisites:
- Java 25 JDK
@@ -158,7 +168,7 @@ This repository contains the StreamPipes platform, SDKs,
extensions, installers,
- [`streampipes-extensions`](streampipes-extensions) for bundled adapters and
pipeline elements
- [`streampipes-sdk`](streampipes-sdk) for extension development
- [`ui`](ui) for the web application
-- [`installer`](installer) for Compose, CLI, and Kubernetes deployment options
+- [`installer`](installer) for Compose, deprecated CLI, and Kubernetes
deployment options
## Extending StreamPipes
diff --git a/installer/cli/README.md b/installer/cli/README.md
index bbac1f1076..75ece2b5a3 100644
--- a/installer/cli/README.md
+++ b/installer/cli/README.md
@@ -17,6 +17,8 @@
-->
# StreamPipes CLI - The Developer's Favorite
+> **Deprecated:** The StreamPipes CLI is deprecated and will be removed in a
future release. The functionality remains available for now, but new
development setups should use the experimental dev container setup in
[`../../.devcontainer`](../../.devcontainer).
+
The StreamPipes command-line interface (CLI) is focused on developers in order
to provide an easy entrypoint to set up a suitable dev environment, either
planning on developing
* new extensions such as **connect adapters, processors, sinks** or,
