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 22, 22:00 UTC
chore(cli): update README
jkomyno committed
Jul 29, 2025 at 06:17 UTC
32826b2637804d2d272c3cd7118738559d3fdb64
1 file changed
+26
ts/packages/cli/README.md
+26
@@ -52,6 +52,7 @@ By default, this file is stored in `~/.composio`, but you can specify a custom l
52
| COMPOSIO_CACHE_DIR | - | The directory where the Composio CLI stores cache files | ~/.composio |
53
| COMPOSIO_LOG_LEVEL | - | The log level for the Composio CLI | None |
54
| DEBUG_OVERRIDE_VERSION | - | The version to use when upgrading the Composio CLI (for debugging) | None |
55
+| FORCE_USE_CACHE | - | Whether to force the use of previously cached HTTP responses | false |
56
57
Additionally, `composio upgrade` supports the following environment variables:
58
@@ -63,6 +64,31 @@ Additionally, `composio upgrade` supports the following environment variables:
64
| COMPOSIO_GITHUB_TAG | The tag to use when fetching the Composio CLI binary from Github | latest |
65
| COMPOSIO_GITHUB_ACCESS_TOKEN | The access token for the GitHub API. Useful during development to avoid getting rate-limited by Github | None |
66
67
+## Caching
68
+
69
+The CLI implements a file-based caching system for improved performance and offline capabilities.
70
+
71
+### Cache Features
72
+
73
+- **Cache-first reads**: When `FORCE_USE_CACHE=true`, the CLI first checks for cached data before making API calls
74
+- **Best-effort writes**: All successful API responses are automatically cached to disk for future use
75
+- **Graceful fallback**: If cache files are corrupted or missing, the CLI falls back to making API calls
76
+- **Parameter-aware caching**: Methods with parameters include those parameters in the cache key
77
+
78
+### Cache Structure
79
+
80
+Cache files are stored in the directory specified by:
81
+
82
+1. `COMPOSIO_CACHE_DIR` environment variable (if set)
83
+2. `~/.composio/` directory (default)
84
+
85
+The following files are cached:
86
+
87
+- `toolkits.json` - Results from toolkit listings
88
+- `tools.json` - Results from tool listings
89
+- `trigger-types-as-enums.json` - Results from trigger type enumerations
90
+- `trigger-types.json` - Results from paginated trigger types payloads
91
+
92
## Development
93
94
### Installation