Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

ci(cli): align installer workflows with auto shell-setup default

jkomyno970562cf9df1
diff --git a/.github/workflows/build-cli-binaries.yml b/.github/workflows/build-cli-binaries.yml
index c529ff491..bee0a1dc6 100644
--- a/.github/workflows/build-cli-binaries.yml
+++ b/.github/workflows/build-cli-binaries.yml
@@ -314,6 +314,22 @@ jobs:
curl -fsSL https://composio.dev/install | sh
```
+ The installer downloads the CLI and sets up your shell automatically: when
+ your login shell (`$SHELL`) is zsh, bash, or fish, it adds the CLI's
+ directory to `PATH` in that shell's startup file. Re-running the installer
+ never duplicates the entry.
+
+ ### Install without shell setup
+
+ ```bash
+ curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=none sh
+ ```
+
+ Use `COMPOSIO_INSTALL_SHELL=none` in CI, Docker images, or when you manage
+ shell startup files yourself: it installs the CLI and leaves every startup
+ file untouched. Set `COMPOSIO_INSTALL_SHELL=zsh`, `bash`, or `fish` instead
+ to configure a specific shell regardless of `$SHELL`.
+
### Install specific version
```bash
curl -fsSL https://composio.dev/install | sh -s -- RELEASE_TAG_PLACEHOLDER
@@ -341,7 +357,9 @@ jobs:
export PATH="$COMPOSIO_BIN_DIR:$PATH"
```
- Run `curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=zsh sh`, replacing `zsh` with `bash` or `fish`, when you want the CLI to configure your shell.
+ After a manual installation, run `composio install` to add the CLI to your
+ shell's `PATH` permanently (or `composio install --shell zsh|bash|fish` to
+ target a specific shell).
## Usage
diff --git a/.github/workflows/cli.install-e2e.yml b/.github/workflows/cli.install-e2e.yml
index 0ae35d231..81e7863a8 100644
--- a/.github/workflows/cli.install-e2e.yml
+++ b/.github/workflows/cli.install-e2e.yml
@@ -193,9 +193,11 @@ jobs:
echo ""
echo '```sh'
echo "curl -fsSL \"$RAW_BASE/install.sh\" | sh"
- echo "curl -fsSL \"$RAW_BASE/install.sh\" | COMPOSIO_INSTALL_SHELL=zsh sh"
+ echo "curl -fsSL \"$RAW_BASE/install.sh\" | COMPOSIO_INSTALL_SHELL=none sh"
echo '```'
echo ""
+ echo "The first command is the default flow: it installs the CLI and configures your shell automatically. The second installs only, without touching shell startup files."
+ echo ""
echo "Shell-specific setup routes (the override points the variant at this PR's base installer):"
echo ""
echo '```sh'
diff --git a/.github/workflows/cli.install-health-check.yml b/.github/workflows/cli.install-health-check.yml
index 24f8d77e3..433a0145d 100644
--- a/.github/workflows/cli.install-health-check.yml
+++ b/.github/workflows/cli.install-health-check.yml
@@ -41,7 +41,10 @@ jobs:
- name: Install newest stable (pinned — fails on a release with missing assets)
run: |
set -euo pipefail
- curl -fsSL https://composio.dev/install | sh -s -- "${{ steps.resolve.outputs.tag }}"
+ # Install-only leg: this step's signal is asset availability, so it opts out of
+ # automatic shell setup with COMPOSIO_INSTALL_SHELL=none. Default-flow (auto)
+ # coverage stays with the no-arg leg below.
+ curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=none sh -s -- "${{ steps.resolve.outputs.tag }}"
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
- name: Verify pinned installation
@@ -53,8 +56,10 @@ jobs:
which composio
composio --version
- # Secondary: the default no-arg flow most users run. Asset-aware and self-healing, so it
- # is a coverage net rather than the primary signal.
+ # Secondary: the default no-arg flow most users run, exactly as they run it — including
+ # automatic shell setup (the default infers the shell from $SHELL; the idempotent rc
+ # edit on this ephemeral runner is harmless). Asset-aware and self-healing, so it is a
+ # coverage net rather than the primary signal.
- name: Install via default no-arg flow
run: |
set -euo pipefail
diff --git a/.github/workflows/cli.test-installation.yml b/.github/workflows/cli.test-installation.yml
index 00e11dbb8..a20572fdc 100644
--- a/.github/workflows/cli.test-installation.yml
+++ b/.github/workflows/cli.test-installation.yml
@@ -190,11 +190,34 @@ jobs:
exit 1
fi
+ # The default (COMPOSIO_INSTALL_SHELL unset → auto) infers the target
+ # shell from $SHELL, which "Setup shell environment" exported for this
+ # matrix leg, so this no-argument install must persist a managed PATH
+ # block in that shell's startup file.
+ if [[ "${{ matrix.shell }}" == "zsh" ]]; then
+ config_file=~/.zshrc
+ else
+ config_file=~/.bashrc
+ fi
+
+ if grep -Fqx '# Composio CLI' "$config_file" \
+ && grep -Fqx 'export PATH="$HOME/.local/bin:$PATH"' "$config_file"; then
+ echo "✅ $config_file gained the managed Composio PATH block via automatic shell setup"
+ else
+ echo "❌ $config_file missing the managed Composio PATH block after the no-argument install"
+ echo "=== $config_file contents ==="
+ cat "$config_file"
+ exit 1
+ fi
+
- name: Test PATH integration
shell: bash
run: |
echo "Testing PATH integration with ${{ matrix.shell }}..."
+ # The no-argument install above already configured this shell through
+ # the auto default; this exercises the CLI command directly and must
+ # stay idempotent on top of it.
COMPOSIO_BIN_DIR="$HOME/.local/bin" "$HOME/.composio/composio" install --shell "${{ matrix.shell }}"
# Debug: Check what files exist and their contents
@@ -345,11 +368,28 @@ jobs:
exit 1
fi
+ # Automatic setup ran during the no-argument install and `composio
+ # install --shell` ran again afterwards: setup is idempotent, so the
+ # startup file must hold exactly one managed block.
+ marker_count=$(grep -Fcx '# Composio CLI' "$config_file" || true)
+ if [[ "$marker_count" == "1" ]]; then
+ echo "✅ $config_file contains exactly one managed Composio block"
+ else
+ echo "❌ $config_file contains $marker_count managed Composio blocks (expected 1)"
+ echo "=== $config_file contents ==="
+ cat "$config_file"
+ exit 1
+ fi
+
- name: Test custom install directory
shell: bash
env:
USE_LATEST: ${{ steps.release_target.outputs.use_latest }}
RELEASE_TAG: ${{ steps.release_target.outputs.release_tag }}
+ # Install-only step: it verifies custom install locations, so opt out
+ # of automatic shell setup instead of re-pointing the managed PATH
+ # block at the throwaway custom bin dir.
+ COMPOSIO_INSTALL_SHELL: none
run: |
echo "Testing custom install directory..."