Skip to main content
The composio upgrade command updates your CLI installation to the latest available version.

Usage

Description

The upgrade command:
  1. Fetches the latest release from GitHub
  2. Compares with your current version
  3. Downloads the appropriate binary for your platform
  4. Replaces the existing binary with the new version
  5. Verifies the installation

Examples

Basic Upgrade

Output (when upgrade available):
Output (when already up-to-date):

Verify Upgrade

Confirms the new version is installed.

Platform Detection

The upgrade command automatically detects your platform and downloads the appropriate binary:
Windows is not supported. Use WSL or install via npm (npm install -g @composio/cli).

Release Tags

CLI binaries are published as GitHub release assets with the tag format:
Example: @composio/cli@0.1.33
Legacy v<semver> tags (e.g., v0.1.24) are supported during the migration period for backward compatibility.

Environment Variables

The upgrade command supports these environment variables for customization:
string
default:"https://api.github.com"
GitHub API base URL (useful for GitHub Enterprise)
string
default:"ComposioHQ"
GitHub repository owner
string
default:"composio"
GitHub repository name
string
default:"latest"
Specific release tag to upgrade to
string
GitHub access token (prevents rate limiting during development)
string
Override version for debugging (development use only)

Examples

Upgrade to Specific Version

Downloads and installs version 0.1.24 instead of the latest.

Custom GitHub API (Enterprise)

Uses a GitHub Enterprise instance.

Avoid Rate Limiting

Provides a GitHub token to increase API rate limits.

Installation Location

The upgrade replaces the binary at:
Or the location specified by COMPOSIO_INSTALL during initial installation.

Version Comparison

The CLI uses semantic versioning (semver) to compare versions:
  • Major: Breaking changes (e.g., 1.0.0 → 2.0.0)
  • Minor: New features (e.g., 0.1.0 → 0.2.0)
  • Patch: Bug fixes (e.g., 0.1.0 → 0.1.1)
The upgrade only proceeds if a newer version is available.

Troubleshooting

Permission Denied

If you get permission errors during upgrade:
Or run the upgrade with appropriate permissions:

Download Failures

If the download fails: 1. Check internet connection 2. Verify GitHub access:
3. Use a GitHub token to avoid rate limits:

Rate Limiting

GitHub API has rate limits (60 requests/hour for unauthenticated users). If you hit the limit:
Solution: Provide a GitHub token:

Unsupported Platform

If your platform is not supported:
Solution for Windows: Use WSL or install via npm:

Manual Upgrade

If the automatic upgrade fails, you can manually upgrade:
This runs the installation script, which handles upgrades automatically.

Rollback

If you need to downgrade to a previous version:
Or reinstall from scratch:

Next Steps

version

Check your CLI version

Installation

Installation guide