@devries-cameron20 / composio Mirror · read-only / commits / 9e01e1754
Fork 0

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

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 17:15 UTC

docs(cli): address installer docs review findings

- make the documented uninstall strip legacy three-line PATH blocks (dangling 'export PATH' left cwd on PATH) and preserve symlinked rc files by writing back in place instead of mv - point readers at Configure your shell before 'composio login' when ~/.local/bin is not on PATH - restore an Update section covering 'composio upgrade', version pinning, and --beta - drop the completions claim from install.sh post-install help; shell routes configure PATH only - replace the nonexistent @composio/cli@0.3.1-beta.2 example tag with the published 0.3.1-beta.329 - add the missing changelog description and note that the uninstall file list tracks the current release layout

jkomyno committed Aug 1, 2026 at 18:33 UTC 9e01e1754e6ffbc9331e83646014bd127bf064c8
4 files changed +23 -8
INSTALL.md
+3 -3
@@ -18,7 +18,7 @@ Pin a stable or beta release with `COMPOSIO_INSTALL_VERSION`, or pass the tag as
18
19 ```bash
20 curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_VERSION=0.3.1 sh
21 -curl -fsSL https://composio.dev/install | sh -s -- @composio/cli@0.3.1-beta.2
21 +curl -fsSL https://composio.dev/install | sh -s -- @composio/cli@0.3.1-beta.329
22 ```
23
24 The positional argument takes precedence over `COMPOSIO_INSTALL_VERSION`.
@@ -71,7 +71,7 @@ which composio
71
72 ## Uninstall
73
74 -Remove the entry point and release artifacts without deleting credentials, configuration, or caches:
74 +Remove the entry point and release artifacts without deleting credentials, configuration, or caches. The file list below matches the current release layout; if you installed a different version, compare it against the contents of that release's archive.
75
76 ```bash
77 install_dir=${COMPOSIO_INSTALL_DIR:-"$HOME/.composio"}
@@ -92,7 +92,7 @@ rm -rf \
92 "$install_dir/local-tools-binaries"
93 ```
94
95 -Remove `# Composio CLI` PATH blocks from `~/.zshrc`, `~/.bashrc`, `~/.bash_profile`, `~/.bash_login`, or `~/.config/fish/config.fish` if you used a shell-specific installer.
95 +Remove `# Composio CLI` PATH blocks from `~/.zshrc`, `~/.bashrc`, `~/.bash_profile`, `~/.bash_login`, or `~/.config/fish/config.fish` if you used a shell-specific installer. Blocks written by older installers contain an extra `export COMPOSIO_INSTALL_DIR=...` line after the marker; remove that line too.
96
97 To purge credentials, configuration, caches, and every other CLI file, run `rm -rf "${COMPOSIO_INSTALL_DIR:-$HOME/.composio}"`. This is a complete reset and cannot be undone.
98
docs/content/changelog/07-31-26-installer.mdx
+1
@@ -1,5 +1,6 @@
1 ---
2 title: "Install the Composio CLI with a POSIX shell"
3 +description: "The CLI installer now runs on POSIX sh, keeps the release bundle separate from the entry point, and makes shell configuration opt-in."
4 date: "2026-07-31"
5 ---
6
docs/content/docs/cli.mdx
+17 -3
@@ -18,6 +18,8 @@ curl -fsSL https://composio.dev/install | sh
18
19 The installer downloads and verifies the release bundle in `~/.composio`, then creates the `~/.local/bin/composio` entry point. It does not edit shell files, install agent plugins, or log you in.
20
21 +If the installer reports that `~/.local/bin` is not on your `PATH`, run the command it prints for your shell — see [Configure your shell](#configure-your-shell) — and start a new shell.
22 +
23 Log in after `composio` is available:
24
25 ```bash
@@ -101,6 +103,14 @@ which composio
103
104 The installer supports Linux x64, Linux ARM64, macOS Intel, and macOS Apple Silicon. On Windows, install and run it inside [WSL](https://learn.microsoft.com/windows/wsl/install).
105
106 +### Update
107 +
108 +```bash
109 +composio upgrade
110 +```
111 +
112 +This replaces the bundle in `~/.composio` in place and leaves the `~/.local/bin/composio` entry point pointing at it. Pass a version to pin a specific release (`composio upgrade 0.3.1`), or `--beta` for the latest prerelease.
113 +
114 ### Install manually from GitHub Releases
115
116 Download the archive for your platform from [GitHub Releases](https://github.com/ComposioHQ/composio/releases), then install the complete bundle. Keep the support files beside the executable.
@@ -123,7 +133,7 @@ export PATH="$COMPOSIO_BIN_DIR:$PATH"
133
134 ### Uninstall
135
126 -Remove only installer-owned entry points and release artifacts. This keeps your credentials, configuration, and cache data in `~/.composio`.
136 +Remove only installer-owned entry points and release artifacts. This keeps your credentials, configuration, and cache data in `~/.composio`. The file list below matches the current release layout; if you installed a different version, compare it against the contents of that release's archive.
137
138 ```bash
139 install_dir=${COMPOSIO_INSTALL_DIR:-"$HOME/.composio"}
@@ -150,8 +160,12 @@ for file in \
160 "$HOME/.bash_login" \
161 "$HOME/.config/fish/config.fish"; do
162 [ -f "$file" ] || continue
153 - sed '/^# Composio CLI$/ { N; d; }' "$file" > "$file.tmp"
154 - mv "$file.tmp" "$file"
163 + awk '
164 + /^# Composio CLI$/ { skip = 1; next }
165 + skip && (/^export PATH=/ || /^export COMPOSIO_INSTALL_DIR=/ || /^set --export /) { next }
166 + { skip = 0; print }
167 + ' "$file" > "$file.tmp"
168 + cat "$file.tmp" > "$file" && rm -f "$file.tmp"
169 done
170 ```
171
install.sh
+2 -2
@@ -45,7 +45,7 @@ print_usage() {
45 ' --no-plugins Skip agent plugin installation (the default).' \
46 ' -h, --help Show this help.' \
47 '' \
48 - 'Version tags may be stable or beta, for example 0.3.1 or @composio/cli@0.3.1-beta.2.'
48 + 'Version tags may be stable or beta, for example 0.3.1 or @composio/cli@0.3.1-beta.329.'
49 }
50
51 validate_identifier() {
@@ -307,7 +307,7 @@ print_post_install_help() {
307 if [ "$guidance_required" = 1 ]; then
308 printf 'Required next step for %s:\n\n' "$shell_name"
309 else
310 - printf 'Optional shell setup for completions and future PATH changes:\n\n'
310 + printf 'Optional shell setup for future PATH changes:\n\n'
311 fi
312 printf ' curl -fsSL https://composio.dev/install/%s | sh\n' "$shell_route"
313 printf '\nThis configures %s.\n' "$shell_config"