55
56
By default, this file is stored in `~/.composio`, but you can specify a custom location using the `COMPOSIO_CACHE_DIR` environment variable.
57
58
-| Environment Variable | User JSON config | Description | Default |
59
-| ---------------------- | ---------------- | ------------------------------------------------------------------ | ------------------------------- |
60
-| COMPOSIO_API_KEY | `api_key` | Composio backend API key | None |
61
-| COMPOSIO_BASE_URL | `base_url` | The base URL of the Composio backend API | https://backend.composio.dev |
62
-| COMPOSIO_WEB_URL | `web_url` | The base URL of the Composio web app | https://dashboard.composio.dev/ |
63
-| COMPOSIO_CACHE_DIR | - | The directory where the Composio CLI stores cache files | ~/.composio |
64
-| COMPOSIO_LOG_LEVEL | - | The log level for the Composio CLI | None |
65
-| DEBUG_OVERRIDE_VERSION | - | The version to use when upgrading the Composio CLI (for debugging) | None |
66
-| FORCE_USE_CACHE | - | Whether to force the use of previously cached HTTP responses | None |
67
-| NO_COLOR | - | If set, disables color output in the CLI (https://no-color.org/) | None |
58
+| Environment Variable | User JSON config | Description | Default |
59
+| ---------------------- | ---------------- | ------------------------------------------------------------------ | -------------------------------- |
60
+| COMPOSIO_API_KEY | `api_key` | Composio backend API key | None |
61
+| COMPOSIO_BASE_URL | `base_url` | The base URL of the Composio backend API | https://backend.composio.dev |
62
+| COMPOSIO_WEB_URL | `web_url` | The base URL of the Composio web app | https://dashboard.composio.dev/ |
63
+| COMPOSIO_CACHE_DIR | - | The directory where the Composio CLI stores cache files | ~/.composio |
64
+| COMPOSIO_BIN_DIR | - | The directory `composio install` adds to `PATH` (see below) | Resolved from the running binary |
65
+| COMPOSIO_LOG_LEVEL | - | The log level for the Composio CLI | None |
66
+| DEBUG_OVERRIDE_VERSION | - | The version to use when upgrading the Composio CLI (for debugging) | None |
67
+| FORCE_USE_CACHE | - | Whether to force the use of previously cached HTTP responses | None |
68
+| NO_COLOR | - | If set, disables color output in the CLI (https://no-color.org/) | None |
69
70
Additionally, `composio upgrade` supports the following environment variables:
71
77
| COMPOSIO_GITHUB_TAG | The tag to use when fetching the Composio CLI binary from Github | latest |
78
| COMPOSIO_GITHUB_ACCESS_TOKEN | The access token for the GitHub API. Useful during development to avoid getting rate-limited by Github | None |
79
80
+### Choosing the PATH entry with `COMPOSIO_BIN_DIR`
81
+
82
+`composio install` writes a single `PATH` line into your shell config. The directory it points at is resolved in this order:
83
+
84
+1. `COMPOSIO_BIN_DIR`, when set to an absolute path
85
+2. `~/.local/bin`, when its `composio` entry point resolves to the binary that is running
86
+3. the directory of the running binary
87
+
88
+Set `COMPOSIO_BIN_DIR` when the entry point users should reach is not the binary itself — a shim, a symlink farm, or a version-manager `bin` directory:
89
+
90
+```bash
91
+COMPOSIO_BIN_DIR="$HOME/.local/bin" composio install
92
+```
93
+
94
+The command aborts with a non-zero exit code, writing nothing, when the resolved directory is relative or contains a character that cannot be embedded safely in a quoted rc line (`` ` ``, `$`, `"`, `\`, a newline, or the `:` PATH separator).
95
+
96
### CLI binary release tags
97
98
CLI binaries are published as GitHub release assets.