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, 14:30 UTC
chore(ts/cli): update README
jkomyno committed
Jan 14, 2026 at 16:11 UTC
317c27519d6add07b4ef782221236b4abcaa60b2
1 file changed
+20
-19
ts/packages/cli/README.md
+20
-19
@@ -6,7 +6,7 @@ This package defines the Composio CLI used to interact with the Composio Platfor
6
7
## Overview
8
9
-The CLI is build using:
9
+The CLI is built using:
10
11
- [TypeScript](https://www.typescriptlang.org/)
12
- [The Effect ecosystem](https://effect.website/docs)
@@ -25,18 +25,18 @@ composio [--log-level all|trace|debug|info|warning|error|fatal|none]
25
26
## 🧭 Commands
27
28
-| Command | Description | Status |
29
-| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
30
-| `composio version` | Display the current CLI version. | ✅ |
31
-| `composio whoami` | Show the currently logged-in user/account. | ✅ It displays the local API_KEY, or shows a message if no API_KEY is found. |
32
-| `composio login` | Log in to the Composio SDK. | ✅ |
33
-| `composio logout` | Log out from the Composio SDK. | ✅ |
34
-| `composio generate [-o, --output-dir <directory>]` | Auto-detect the project language (Python or TypeScript) and generate the latest app type stubs. | ✅ |
35
-| `composio py` | Python project-specific commands. |
36
-| `composio py generate [-o, --output-dir <directory>]` | Generate updated Python stubs with the latest app data. | ✅ |
37
-| `composio ts` | TypeScript project-specific commands. | ✅ |
38
-| `composio ts generate [-o, --output-dir <directory>] [--single-file]` | Generate updated TypeScript stubs, optionally as a single file. | ✅ |
39
-| `composio upgrade` | Self-update the Composio CLI if a new release is out. | ✅ yet |
28
+| Command | Description |
29
+| ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
30
+| `composio version` | Display the current CLI version. |
31
+| `composio whoami` | Show the currently logged-in user/account. |
32
+| `composio login [--no-browser]` | Log in to the Composio SDK. |
33
+| `composio logout` | Log out from the Composio SDK. |
34
+| `composio generate [-o, --output-dir <directory>] [--toolkits <toolkit>] [--type-tools]` | Auto-detect the project language (Python or TypeScript) and generate type stubs for toolkits, tools, and triggers. |
35
+| `composio py` | Python project-specific commands. |
36
+| `composio py generate [-o, --output-dir <directory>] [--toolkits <toolkit>]` | Generate Python type stubs for toolkits, tools, and triggers from the Composio API. |
37
+| `composio ts` | TypeScript project-specific commands. |
38
+| `composio ts generate [-o, --output-dir <directory>] [--compact] [--transpiled] [--type-tools] [--toolkits <toolkit>]` | Generate TypeScript types for toolkits, tools, and triggers from the Composio API. |
39
+| `composio upgrade` | Self-update the Composio CLI if a new release is out. |
40
41
## Configuration
42
@@ -72,10 +72,10 @@ The CLI implements a file-based caching system for improved performance and offl
72
73
### Cache Features
74
75
-- **Cache-first reads**: When `FORCE_USE_CACHE=true`, the CLI first checks for cached data before making API calls
76
-- **Best-effort writes**: All successful API responses are automatically cached to disk for future use
77
-- **Graceful fallback**: If cache files are corrupted or missing, the CLI falls back to making API calls
78
-- **Parameter-aware caching**: Methods with parameters include those parameters in the cache key
75
+- **Cache-first reads**: When `FORCE_USE_CACHE=true`, the CLI first checks for cached data before making API calls. If you already ran `composio generate` before, it will work even if you're offline.
76
+- **Best-effort writes**: All successful API responses are automatically cached to disk for future use.
77
+- **Graceful fallback**: If cache files are corrupted or missing, the CLI falls back to making API calls.
78
+- **Parameter-aware caching**: Methods with parameters include those parameters in the cache key.
79
80
### Cache Structure
81
@@ -87,6 +87,7 @@ Cache files are stored in the directory specified by:
87
The following files are cached:
88
89
- `toolkits.json` - Results from toolkit listings
90
+- `tools-as-enums.json` - Results from tool enum listings
91
- `tools.json` - Results from tool listings
92
- `trigger-types-as-enums.json` - Results from trigger type enumerations
93
- `trigger-types.json` - Results from paginated trigger types payloads
@@ -108,7 +109,7 @@ bun run build
109
### Build self-contained executable
110
111
```bash
111
-bun build:bin
112
+bun run build:bin
113
```
114
115
or
@@ -120,7 +121,7 @@ bun run ./scripts/build-binary.ts
121
### Install self-contained executable
122
123
```bash
123
-bun install:bin
124
+bun run install:bin
125
```
126
127
or