@devries-cameron20 / composio Mirror · read-only / commits / a5fa8a147
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 22, 08:15 UTC

feat(cli): add TerminalUI service with Clack prompts for beautiful CLI output

Replace plain Console.log output across all CLI commands with structured terminal UI using @clack/prompts via a new TerminalUI Effect service. - Create TerminalUI service (intro/outro, log.*, note, withSpinner, makeSpinner) - TerminalUILive wraps @clack/prompts for production (spinners, styled logs) - TerminalUITest routes through MockConsole for deterministic test assertions - Migrate all 7 commands: version, whoami, logout, login, generate, ts/py generate, upgrade - Add spinners for long-running operations (API fetches, login polling, download) - Add intro/outro framing for multi-step commands (login, generate, upgrade) - Remove ansis dependency, consolidate on picocolors

jkomyno committed Feb 18, 2026 at 11:40 UTC a5fa8a14700d51c3486e287b7b36ad03ffc66af9
18 files changed +318 -82
.gitmodules
+3
@@ -2,3 +2,6 @@
2 path = ts/vendor/effect
3 url = git@github.com:Effect-TS/effect.git
4 branch = main
5 +[submodule "ts/vendor/clack"]
6 + path = ts/vendor/clack
7 + url = https://github.com/bombshell-dev/clack.git
CLAUDE.md
+15
@@ -25,6 +25,21 @@ When working on CLI code, reference the Effect source for accurate patterns:
25
26 **Important:** The submodule is for **read-only reference only**. Do not modify files in `ts/vendor/`. The CLI's actual dependencies come from npm via `pnpm install`.
27
28 +## Clack Reference Source
29 +
30 +The CLI uses [`@clack/prompts`](https://github.com/bombshell-dev/clack) for interactive terminal UI. A local copy of the Clack source code is available as a git submodule:
31 +
32 +- **Location:** `ts/vendor/clack/`
33 +- **Repo:** [bombshell-dev/clack](https://github.com/bombshell-dev/clack)
34 +
35 +When working on CLI prompts and terminal UI, reference the Clack source for accurate APIs:
36 +- `ts/vendor/clack/packages/prompts/src/` — `@clack/prompts` (high-level API: text, select, confirm, spinner, etc.)
37 +- `ts/vendor/clack/packages/core/src/` — `@clack/core` (low-level primitives)
38 +
39 +See `ts/packages/cli/AGENTS.md` for detailed Clack usage guidelines.
40 +
41 +**Important:** The submodule is for **read-only reference only**. Do not modify files in `ts/vendor/`. The CLI's actual `@clack/prompts` dependency comes from npm via `pnpm install`.
42 +
43 ## Common Development Commands
44
45 ### Build and Development
ts/packages/cli/src/bin.ts
+2
@@ -20,6 +20,7 @@ import { EnvLangDetector } from 'src/services/env-lang-detector';
20 import { JsPackageManagerDetector } from 'src/services/js-package-manager-detector';
21 import { ComposioUserContextLive as _ComposioUserContextLive } from 'src/services/user-context';
22 import { UpgradeBinary } from 'src/services/upgrade-binary';
23 +import { TerminalUILive } from 'src/services/terminal-ui';
24
25 /**
26 * Concrete Effect layer compositions for the Composio CLI runtime.
@@ -76,6 +77,7 @@ const layers = Layer.mergeAll(
77 JsPackageManagerDetector.Default,
78 BunContext.layer,
79 BunFileSystem.layer,
80 + TerminalUILive,
81 Logger.pretty
82 ) satisfies RequiredLayer;
83
ts/packages/cli/src/commands/generate.cmd.ts
+4 -2
@@ -1,7 +1,8 @@
1 import { Command, Options } from '@effect/cli';
2 -import { Effect, Console, Match } from 'effect';
2 +import { Effect, Match } from 'effect';
3 import { EnvLangDetector } from 'src/services/env-lang-detector';
4 import { NodeProcess } from 'src/services/node-process';
5 +import { TerminalUI } from 'src/services/terminal-ui';
6 import { generateTypescriptTypeStubs } from './ts/commands/ts.generate.cmd';
7 import { generatePythonTypeStubs } from './py/commands/py.generate.cmd';
8
@@ -37,13 +38,14 @@ export const generateCmd = Command.make('generate', { outputOpt, typeTools, tool
38 ),
39 Command.withHandler(({ outputOpt, typeTools, toolkitsOpt }) =>
40 Effect.gen(function* () {
41 + const ui = yield* TerminalUI;
42 const process = yield* NodeProcess;
43 const cwd = process.cwd;
44
45 yield* Effect.logDebug('Identifying project type...');
46 const envLangDetector = yield* EnvLangDetector;
47 const envLang = yield* envLangDetector.detectEnvLanguage(cwd);
46 - yield* Console.log(`Project type detected: ${envLang}`);
48 + yield* ui.log.step(`Project type detected: ${envLang}`);
49
50 // Redirect to either `ts generate` or `py generate` commands
51 yield* Match.value(envLang).pipe(
ts/packages/cli/src/commands/login.cmd.ts
+20 -10
@@ -1,9 +1,9 @@
1 import { Command, Options } from '@effect/cli';
2 -import { Effect, Console, Schedule } from 'effect';
3 -import { green } from 'ansis';
2 +import { Effect, Schedule } from 'effect';
3 import open, { apps } from 'open';
4 import { ComposioSessionRepository } from 'src/services/composio-clients';
5 import { ComposioUserContext } from 'src/services/user-context';
6 +import { TerminalUI } from 'src/services/terminal-ui';
7
8 export const noBrowser = Options.boolean('no-browser').pipe(
9 Options.withDefault(false),
@@ -20,13 +20,17 @@ export const noBrowser = Options.boolean('no-browser').pipe(
20 */
21 export const loginCmd = Command.make('login', { noBrowser }, ({ noBrowser }) =>
22 Effect.gen(function* () {
23 + const ui = yield* TerminalUI;
24 const ctx = yield* ComposioUserContext;
25
26 + yield* ui.intro('composio login');
27 +
28 if (ctx.isLoggedIn()) {
26 - yield* Console.log(`✔ You're already logged in!.`);
27 - yield* Console.log(
28 - `✔ If you want to log in with a different account, please run \`composio logout\` first.`
29 + yield* ui.log.warn(`You're already logged in!`);
30 + yield* ui.log.info(
31 + `If you want to log in with a different account, please run \`composio logout\` first.`
32 );
33 + yield* ui.outro('');
34 return;
35 }
36
@@ -41,12 +45,12 @@ export const loginCmd = Command.make('login', { noBrowser }, ({ noBrowser }) =>
45 const url = `${ctx.data.webURL}?cliKey=${session.id}`;
46
47 if (noBrowser) {
44 - yield* Console.log(`> Please login using the following URL:`);
48 + yield* ui.log.info('Please login using the following URL:');
49 } else {
46 - yield* Console.log(`> Redirecting you to the login page`);
50 + yield* ui.log.step('Redirecting you to the login page');
51 }
52
49 - yield* Console.log(green`> ${url}`);
53 + yield* ui.note(url, 'Login URL');
54
55 if (!noBrowser) {
56 // Open the given `url` in the default browser
@@ -60,6 +64,9 @@ export const loginCmd = Command.make('login', { noBrowser }, ({ noBrowser }) =>
64 );
65 }
66
67 + // Spinner during session polling
68 + const spinner = yield* ui.makeSpinner('Waiting for login...');
69 +
70 // Retry operation until the session status is "linked" with exponential backoff
71 const linkedSession = yield* Effect.retry(
72 Effect.gen(function* () {
@@ -82,12 +89,15 @@ export const loginCmd = Command.make('login', { noBrowser }, ({ noBrowser }) =>
89 Schedule.intersect(Schedule.recurs(15)),
90 Schedule.intersect(Schedule.spaced('5 seconds'))
91 )
85 - );
92 + ).pipe(Effect.tapError(() => spinner.error('Login timed out. Please try again.')));
93 +
94 + yield* spinner.stop('Login successful');
95
96 yield* Effect.logDebug(`Linked session: ${JSON.stringify(linkedSession)}`);
97
98 yield* ctx.login(linkedSession.api_key);
99
91 - yield* Console.log(`Logged in with user account ${linkedSession.account.email}`);
100 + yield* ui.log.success(`Logged in with user account ${linkedSession.account.email}`);
101 + yield* ui.outro("You're all set!");
102 })
103 ).pipe(Command.withDescription('Log in to the Composio SDK.'));
ts/packages/cli/src/commands/logout.cmd.ts
+5 -3
@@ -1,6 +1,7 @@
1 import { Command } from '@effect/cli';
2 -import { Effect, Console } from 'effect';
2 +import { Effect } from 'effect';
3 import { ComposioUserContext } from 'src/services/user-context';
4 +import { TerminalUI } from 'src/services/terminal-ui';
5
6 /**
7 * CLI command to log out from the Composio CLI.
@@ -12,14 +13,15 @@ import { ComposioUserContext } from 'src/services/user-context';
13 */
14 export const logoutCmd = Command.make('logout', {}, () =>
15 Effect.gen(function* () {
16 + const ui = yield* TerminalUI;
17 const ctx = yield* ComposioUserContext;
18
19 if (!ctx.isLoggedIn()) {
18 - yield* Console.log('You are not logged in yet. Please run `composio login`.');
20 + yield* ui.log.warn('You are not logged in yet. Please run `composio login`.');
21 return;
22 }
23
24 yield* ctx.logout;
23 - yield* Console.log(`Logged out successfully.`);
25 + yield* ui.log.success('Logged out successfully.');
26 })
27 ).pipe(Command.withDescription('Log out from the Composio SDK.'));
ts/packages/cli/src/commands/py/commands/py.generate.cmd.ts
+19 -13
@@ -1,5 +1,5 @@
1 import { Command, Options } from '@effect/cli';
2 -import { pipe, Console, Effect, Option, Array } from 'effect';
2 +import { pipe, Effect, Option, Array } from 'effect';
3 import { FileSystem } from '@effect/platform';
4 import { ComposioToolkitsRepository } from 'src/services/composio-clients';
5 import { logMetrics } from 'src/effects/log-metrics';
@@ -14,6 +14,7 @@ import {
14 type ToolkitVersionOverrides,
15 } from 'src/effects/toolkit-version-overrides';
16 import { validateToolkitVersionOverrides } from 'src/effects/validate-toolkit-versions';
17 +import { TerminalUI } from 'src/services/terminal-ui';
18
19 export const outputOpt = Options.optional(
20 Options.directory('output-dir', {
@@ -47,11 +48,14 @@ export function generatePythonTypeStubs({
48 toolkitsOpt,
49 }: GetCmdParams<typeof _pyCmd$Generate>) {
50 return Effect.gen(function* () {
51 + const ui = yield* TerminalUI;
52 const process = yield* NodeProcess;
53 const cwd = process.cwd;
54 const fs = yield* FileSystem.FileSystem;
55 const client = yield* ComposioToolkitsRepository;
56
57 + yield* ui.intro('composio py generate');
58 +
59 // Determine the actual output directory
60 const outputDir = yield* outputOpt.pipe(
61 Option.match({
@@ -74,15 +78,13 @@ export function generatePythonTypeStubs({
78 const toolkitSlugsFilter = hasToolkitsFilter ? toolkitsOpt.map(s => s.toLowerCase()) : null;
79
80 // Validate toolkit version overrides before fetching data
77 - // This will log detected overrides, validate them against API, and warn about unused ones
81 const { validatedOverrides } = yield* validateToolkitVersionOverrides({
82 versionOverrides,
83 toolkitSlugsFilter,
84 client,
85 });
86
84 - // Fetch data from Composio API
85 - yield* Console.log('Fetching latest data from Composio API. This may take a while...');
87 + const spinner = yield* ui.makeSpinner('Fetching data from Composio API...');
88
89 // Validate toolkit slugs if specified (separate from version validation)
90 const validatedToolkitSlugs = hasToolkitsFilter
@@ -117,8 +119,8 @@ export function generatePythonTypeStubs({
119 : allToolkits;
120
121 if (hasToolkitsFilter) {
120 - yield* Console.log(
121 - `Filtering to ${toolkits.length} toolkit(s): ${toolkits.map(t => t.slug).join(', ')}`
122 + yield* spinner.message(
123 + `Found ${toolkits.length} toolkit(s): ${toolkits.map(t => t.slug).join(', ')}`
124 );
125 }
126
@@ -133,6 +135,7 @@ export function generatePythonTypeStubs({
135
136 const typeableTools = { withTypes: false as const, tools };
137
138 + yield* spinner.message('Generating Python type stubs...');
139 const index = createToolkitIndex({ toolkits, typeableTools, triggerTypes, versionMap });
140
141 // Generate Python sources
@@ -141,6 +144,8 @@ export function generatePythonTypeStubs({
144 outputDir,
145 })(index);
146
147 + yield* spinner.message('Writing files to disk...');
148 +
149 // Write all generated files
150 yield* pipe(
151 Effect.all(
@@ -154,20 +159,21 @@ export function generatePythonTypeStubs({
159 Effect.mapError(error => new Error(`Failed to write generated files: ${error}`))
160 );
161
162 + yield* spinner.stop('Type stubs generated successfully');
163 +
164 yield* Option.isNone(outputOpt)
158 - ? Console.log(
159 - '✅ Type stubs generated successfully.\n' +
160 - 'You can now import generated types via `from composio.generated.<toolkit_name> import <TOOLKIT_NAME>`.\n'
165 + ? ui.note(
166 + 'from composio.generated.<toolkit_name> import <TOOLKIT_NAME>',
167 + 'Import your generated types'
168 )
162 - : Console.log(
163 - `✅ Type stubs generated successfully.\n` +
164 - `Generated files are available at: ${outputDir}`
165 - );
169 + : ui.log.info(`Generated files are available at: ${outputDir}`);
170
171 // Log API metrics
172 const metrics = yield* client.getMetrics();
173 yield* logMetrics(metrics);
174
175 + yield* ui.outro('Done');
176 +
177 return outputDir;
178 });
179 }
ts/packages/cli/src/commands/ts/commands/ts.generate.cmd.ts
+38 -24
@@ -17,7 +17,7 @@
17
18 import path from 'node:path';
19 import { Command, Options } from '@effect/cli';
20 -import { Console, Effect, Option, pipe, Array } from 'effect';
20 +import { Effect, Option, pipe, Array } from 'effect';
21 import { Match } from 'effect';
22 import { FileSystem } from '@effect/platform';
23 import { ComposioToolkitsRepository } from 'src/services/composio-clients';
@@ -39,6 +39,7 @@ import {
39 type ToolkitVersionOverrides,
40 } from 'src/effects/toolkit-version-overrides';
41 import { validateToolkitVersionOverrides } from 'src/effects/validate-toolkit-versions';
42 +import { TerminalUI, type SpinnerHandle } from 'src/services/terminal-ui';
43
44 export const outputOpt = Options.optional(
45 Options.directory('output-dir', {
@@ -109,10 +110,11 @@ function fetchFilteredData(
110 client: ComposioToolkitsRepository,
111 slugs: ReadonlyArray<string>,
112 typeTools: boolean,
112 - versionOverrides: ToolkitVersionOverrides
113 + versionOverrides: ToolkitVersionOverrides,
114 + spinner: SpinnerHandle
115 ): Effect.Effect<FetchResult, Error, never> {
116 return Effect.gen(function* () {
115 - yield* Console.log(`Fetching data for ${slugs.length} toolkit(s): ${slugs.join(', ')}...`);
117 + yield* spinner.message(`Fetching data for ${slugs.length} toolkit(s): ${slugs.join(', ')}...`);
118
119 // Build version specs for each requested toolkit
120 const versionSpecs = buildToolkitVersionSpecs(slugs, versionOverrides);
@@ -167,8 +169,8 @@ function fetchFilteredData(
169 { concurrency: 'unbounded' }
170 );
171
170 - yield* Console.log(
171 - `Filtering to ${filteredToolkits.length} toolkit(s): ${filteredToolkits.map(t => t.slug).join(', ')}`
172 + yield* spinner.message(
173 + `Found ${filteredToolkits.length} toolkit(s): ${filteredToolkits.map(t => t.slug).join(', ')}`
174 );
175
176 return {
@@ -186,7 +188,8 @@ function fetchFilteredData(
188 */
189 function fetchAllDataFastPath(
190 client: ComposioToolkitsRepository,
189 - typeTools: boolean
191 + typeTools: boolean,
192 + spinner: SpinnerHandle
193 ): Effect.Effect<FetchResult, Error, never> {
194 return Effect.gen(function* () {
195 // Fetch all data in parallel
@@ -218,7 +221,7 @@ function fetchAllDataFastPath(
221 { concurrency: 'unbounded' }
222 );
223
221 - yield* Console.log(`Found ${allToolkits.length} toolkit(s)`);
224 + yield* spinner.message(`Found ${allToolkits.length} toolkit(s)`);
225
226 return {
227 toolkits: allToolkits,
@@ -236,7 +239,8 @@ function fetchAllDataFastPath(
239 function fetchAllDataWithOverrides(
240 client: ComposioToolkitsRepository,
241 typeTools: boolean,
239 - versionOverrides: ToolkitVersionOverrides
242 + versionOverrides: ToolkitVersionOverrides,
243 + spinner: SpinnerHandle
244 ): Effect.Effect<FetchResult, Error, never> {
245 return Effect.gen(function* () {
246 // 1. First fetch all toolkit metadata to know what's available
@@ -277,7 +281,7 @@ function fetchAllDataWithOverrides(
281 { concurrency: 'unbounded' }
282 );
283
280 - yield* Console.log(`Found ${allToolkits.length} toolkit(s)`);
284 + yield* spinner.message(`Found ${allToolkits.length} toolkit(s)`);
285
286 return {
287 toolkits: allToolkits,
@@ -295,16 +299,17 @@ function fetchAllDataWithOverrides(
299 function fetchAllData(
300 client: ComposioToolkitsRepository,
301 typeTools: boolean,
298 - versionOverrides: ToolkitVersionOverrides
302 + versionOverrides: ToolkitVersionOverrides,
303 + spinner: SpinnerHandle
304 ): Effect.Effect<FetchResult, Error, never> {
305 return Effect.gen(function* () {
301 - yield* Console.log('Fetching all toolkits, tools, and triggers from Composio API...');
306 + yield* spinner.message('Fetching all toolkits, tools, and triggers...');
307
308 if (versionOverrides.size === 0) {
304 - return yield* fetchAllDataFastPath(client, typeTools);
309 + return yield* fetchAllDataFastPath(client, typeTools, spinner);
310 }
311
307 - return yield* fetchAllDataWithOverrides(client, typeTools, versionOverrides);
312 + return yield* fetchAllDataWithOverrides(client, typeTools, versionOverrides, spinner);
313 });
314 }
315
@@ -350,11 +355,14 @@ export function generateTypescriptTypeStubs({
355 toolkitsOpt,
356 }: GetCmdParams<typeof _tsCmd$Generate> & { transpiled?: boolean }) {
357 return Effect.gen(function* () {
358 + const ui = yield* TerminalUI;
359 const fs = yield* FileSystem.FileSystem;
360 const process = yield* NodeProcess;
361 const cwd = process.cwd;
362 const client = yield* ComposioToolkitsRepository;
363
364 + yield* ui.intro('composio ts generate');
365 +
366 // Determine the actual output directory
367 const outputDir = yield* outputOpt.pipe(
368 Option.match({
@@ -385,12 +393,14 @@ export function generateTypescriptTypeStubs({
393 client,
394 });
395
388 - // Fetch data using two distinct strategies based on whether --toolkits filter is provided
396 + // Fetch data using a spinner for progress
397 + const spinner = yield* ui.makeSpinner('Fetching data from Composio API...');
398 +
399 const { toolkits, triggerTypes, typeableTools, versionMap } = yield* toolkitSlugsFilter !== null
390 - ? fetchFilteredData(client, toolkitSlugsFilter, typeTools, validatedOverrides)
391 - : fetchAllData(client, typeTools, validatedOverrides);
400 + ? fetchFilteredData(client, toolkitSlugsFilter, typeTools, validatedOverrides, spinner)
401 + : fetchAllData(client, typeTools, validatedOverrides, spinner);
402
393 - yield* Console.log('Writing TypeScript type stubs to disk...');
403 + yield* spinner.message('Generating TypeScript type stubs...');
404 const index = createToolkitIndex({ toolkits, typeableTools, triggerTypes, versionMap });
405
406 // Generate TypeScript sources
@@ -401,6 +411,8 @@ export function generateTypescriptTypeStubs({
411 importExtension: 'js',
412 })(index);
413
414 + yield* spinner.message('Writing files to disk...');
415 +
416 // Write all generated files
417 yield* pipe(
418 Effect.all(
@@ -416,6 +428,7 @@ export function generateTypescriptTypeStubs({
428
429 // Compile TypeScript to JavaScript if needed
430 if (transpiled) {
431 + yield* spinner.message('Transpiling to JavaScript...');
432 yield* pipe(
433 transpileTypeScriptSources({ sources, outputDir }),
434 Effect.catchAll(error =>
@@ -424,20 +437,21 @@ export function generateTypescriptTypeStubs({
437 );
438 }
439
440 + yield* spinner.stop('Type stubs generated successfully');
441 +
442 yield* Option.isNone(outputOpt)
428 - ? Console.log(
429 - '✅ Type stubs generated successfully.\n' +
430 - 'You can now import generated types via `import { Toolkits } from "@composio/core/generated"`'
443 + ? ui.note(
444 + 'import { Toolkits } from "@composio/core/generated"',
445 + 'Import your generated types'
446 )
432 - : Console.log(
433 - `✅ Type stubs generated successfully.\n` +
434 - `Generated files are available at: ${outputDir}`
435 - );
447 + : ui.log.info(`Generated files are available at: ${outputDir}`);
448
449 // Log API metrics
450 const metrics = yield* client.getMetrics();
451 yield* logMetrics(metrics);
452
453 + yield* ui.outro('Done');
454 +
455 return outputDir;
456 });
457 }
ts/packages/cli/src/commands/version.cmd.ts
+4 -2
@@ -1,6 +1,7 @@
1 import { Command } from '@effect/cli';
2 -import { Effect, Console } from 'effect';
2 +import { Effect } from 'effect';
3 import { getVersion } from 'src/effects/version';
4 +import { TerminalUI } from 'src/services/terminal-ui';
5
6 /**
7 * CLI command to display the version of the Composio CLI.
@@ -14,8 +15,9 @@ export const versionCmd = Command.make('version', {}).pipe(
15 Command.withDescription('Display your account information.'),
16 Command.withHandler(() =>
17 Effect.gen(function* () {
18 + const ui = yield* TerminalUI;
19 const version = yield* getVersion;
18 - yield* Console.log(`${version}`);
20 + yield* ui.log.info(version);
21
22 yield* Effect.logDebug('Composio CLI version command executed successfully.');
23 })
ts/packages/cli/src/commands/whoami.cmd.ts
+6 -6
@@ -1,6 +1,7 @@
1 import { Command } from '@effect/cli';
2 -import { Effect, Console, Option } from 'effect';
2 +import { Effect, Option } from 'effect';
3 import { ComposioUserContext } from 'src/services/user-context';
4 +import { TerminalUI } from 'src/services/terminal-ui';
5
6 /**
7 * CLI command to display your account information.
@@ -14,16 +15,15 @@ export const whoamiCmd = Command.make('whoami', {}).pipe(
15 Command.withDescription('Display your account information.'),
16 Command.withHandler(() =>
17 Effect.gen(function* () {
18 + const ui = yield* TerminalUI;
19 const ctx = yield* ComposioUserContext;
20
19 - const message = ctx.data.apiKey.pipe(
21 + yield* ctx.data.apiKey.pipe(
22 Option.match({
21 - onNone: () => 'You are not logged in yet. Please run `composio login`.',
22 - onSome: apiKey => `API KEY: ${apiKey}`,
23 + onNone: () => ui.log.warn('You are not logged in yet. Please run `composio login`.'),
24 + onSome: apiKey => ui.note(apiKey, 'API Key'),
25 })
26 );
25 -
26 - yield* Console.log(message);
27 })
28 )
29 );
ts/packages/cli/src/effects/validate-toolkit-versions.ts
+10 -9
@@ -1,6 +1,7 @@
1 -import { Console, Effect } from 'effect';
1 +import { Effect } from 'effect';
2 import colors from 'picocolors';
3 import { S_BAR, unicodeOr } from '@clack/prompts';
4 +import { TerminalUI } from 'src/services/terminal-ui';
5 import type {
6 ComposioToolkitsRepository,
7 InvalidVersionDetail,
@@ -140,20 +141,20 @@ export const validateToolkitVersionOverrides = ({
141 versionOverrides,
142 toolkitSlugsFilter,
143 client,
143 -}: ValidateVersionsOptions): Effect.Effect<ValidateVersionsResult, Error> =>
144 +}: ValidateVersionsOptions): Effect.Effect<ValidateVersionsResult, Error, TerminalUI> =>
145 Effect.gen(function* () {
146 + const ui = yield* TerminalUI;
147 +
148 // Skip if no overrides
149 if (versionOverrides.size === 0) {
150 return { validatedOverrides: versionOverrides };
151 }
152
153 // Log detected overrides
151 - yield* Console.log('Detected toolkit version overrides:');
152 - for (const [toolkit, version] of versionOverrides) {
153 - yield* Console.log(` - ${toolkit}: ${version}`);
154 - }
155 -
156 - yield* Console.log('Validating toolkit version overrides...');
154 + const overrideLines = [...versionOverrides]
155 + .map(([toolkit, version]) => ` ${toolkit}: ${version}`)
156 + .join('\n');
157 + yield* ui.log.info(`Detected toolkit version overrides:\n${overrideLines}`);
158
159 const { validatedOverrides, warnings } = yield* client
160 .validateToolkitVersions(versionOverrides, toolkitSlugsFilter ?? undefined)
@@ -182,7 +183,7 @@ export const validateToolkitVersionOverrides = ({
183
184 // Log warnings for unused overrides
185 for (const warning of warnings) {
185 - yield* Console.warn(`Warning: ${warning}`);
186 + yield* ui.log.warn(`${warning}`);
187 }
188
189 return { validatedOverrides };
ts/packages/cli/src/services/terminal-ui.ts new
+121
@@ -0,0 +1,121 @@
1 +import * as p from '@clack/prompts';
2 +import { Context, Effect, Exit, Layer } from 'effect';
3 +
4 +// ---------------------------------------------------------------------------
5 +// SpinnerHandle — returned by `makeSpinner` for manual control
6 +// ---------------------------------------------------------------------------
7 +
8 +export interface SpinnerHandle {
9 + /** Update the spinner message while it's running. */
10 + readonly message: (msg: string) => Effect.Effect<void>;
11 + /** Stop the spinner with a success message. */
12 + readonly stop: (msg?: string) => Effect.Effect<void>;
13 + /** Stop the spinner with an error message. */
14 + readonly error: (msg?: string) => Effect.Effect<void>;
15 +}
16 +
17 +// ---------------------------------------------------------------------------
18 +// TerminalUI — Effect service for structured terminal output
19 +// ---------------------------------------------------------------------------
20 +
21 +export interface TerminalUI {
22 + /** Display a session start marker (e.g., `┌ title`). */
23 + readonly intro: (title: string) => Effect.Effect<void>;
24 + /** Display a session end marker (e.g., `└ message`). */
25 + readonly outro: (message: string) => Effect.Effect<void>;
26 +
27 + /** Structured log output with severity-specific symbols. */
28 + readonly log: {
29 + /** Blue info marker. */
30 + readonly info: (message: string) => Effect.Effect<void>;
31 + /** Green success marker. */
32 + readonly success: (message: string) => Effect.Effect<void>;
33 + /** Yellow warning marker. */
34 + readonly warn: (message: string) => Effect.Effect<void>;
35 + /** Red error marker. */
36 + readonly error: (message: string) => Effect.Effect<void>;
37 + /** Green step marker (for completed steps). */
38 + readonly step: (message: string) => Effect.Effect<void>;
39 + /** Generic log message with bar guide. */
40 + readonly message: (message: string) => Effect.Effect<void>;
41 + };
42 +
43 + /** Display a boxed note with optional title. */
44 + readonly note: (message: string, title?: string) => Effect.Effect<void>;
45 +
46 + /**
47 + * Wrap an Effect computation in a spinner.
48 + * The spinner starts before the effect runs and stops/errors on completion.
49 + */
50 + readonly withSpinner: <A, E, R>(
51 + message: string,
52 + effect: Effect.Effect<A, E, R>,
53 + options?: {
54 + readonly successMessage?: string | ((result: A) => string);
55 + readonly errorMessage?: string;
56 + }
57 + ) => Effect.Effect<A, E, R>;
58 +
59 + /**
60 + * Create a controllable spinner for multi-step flows (e.g., login polling).
61 + * The caller is responsible for calling `stop()` or `error()`.
62 + */
63 + readonly makeSpinner: (message: string) => Effect.Effect<SpinnerHandle>;
64 +}
65 +
66 +export const TerminalUI = Context.GenericTag<TerminalUI>('services/TerminalUI');
67 +
68 +// ---------------------------------------------------------------------------
69 +// TerminalUILive — production layer using @clack/prompts
70 +// ---------------------------------------------------------------------------
71 +
72 +const makeLive: TerminalUI = {
73 + intro: title => Effect.sync(() => p.intro(title)),
74 + outro: message => Effect.sync(() => p.outro(message)),
75 +
76 + log: {
77 + info: message => Effect.sync(() => p.log.info(message)),
78 + success: message => Effect.sync(() => p.log.success(message)),
79 + warn: message => Effect.sync(() => p.log.warn(message)),
80 + error: message => Effect.sync(() => p.log.error(message)),
81 + step: message => Effect.sync(() => p.log.step(message)),
82 + message: message => Effect.sync(() => p.log.message(message)),
83 + },
84 +
85 + note: (message, title) => Effect.sync(() => p.note(message, title ?? '')),
86 +
87 + withSpinner: (message, effect, options) =>
88 + Effect.acquireUseRelease(
89 + Effect.sync(() => {
90 + const s = p.spinner();
91 + s.start(message);
92 + return s;
93 + }),
94 + () => effect,
95 + (s, exit) =>
96 + Effect.sync(() => {
97 + if (Exit.isSuccess(exit)) {
98 + const successMsg =
99 + typeof options?.successMessage === 'function'
100 + ? options.successMessage(exit.value)
101 + : (options?.successMessage ?? message);
102 + s.stop(successMsg);
103 + } else {
104 + s.error(options?.errorMessage ?? message);
105 + }
106 + })
107 + ),
108 +
109 + makeSpinner: message =>
110 + Effect.sync(() => {
111 + const s = p.spinner();
112 + s.start(message);
113 + return {
114 + message: (msg: string) => Effect.sync(() => s.message(msg)),
115 + stop: (msg?: string) => Effect.sync(() => s.stop(msg ?? message)),
116 + error: (msg?: string) => Effect.sync(() => s.error(msg ?? message)),
117 + };
118 + }),
119 +};
120 +
121 +export const TerminalUILive = Layer.succeed(TerminalUI, makeLive);
ts/packages/cli/src/services/upgrade-binary.ts
+17 -8
@@ -1,4 +1,4 @@
1 -import { Data, Effect, Console, Config, Option } from 'effect';
1 +import { Data, Effect, Config, Option } from 'effect';
2 import { HttpClient, FileSystem } from '@effect/platform';
3 import * as path from 'node:path';
4 import { APP_VERSION } from '../constants';
@@ -11,6 +11,7 @@ import { CompareSemverError, semverComparator } from 'src/effects/compare-semver
11 import decompress from 'decompress';
12 import type { Predicate } from 'effect/Predicate';
13 import { renderPrettyError } from './utils/pretty-error';
14 +import { TerminalUI } from './terminal-ui';
15
16 export class UpgradeBinaryError extends Data.TaggedError('services/UpgradeBinaryError')<{
17 readonly cause?: unknown;
@@ -138,7 +139,7 @@ export class UpgradeBinary extends Effect.Service<UpgradeBinary>()('services/Upg
139 );
140 }
141
141 - yield* Console.log(`Downloading ${asset.name}...`);
142 + yield* Effect.logDebug(`Downloading ${asset.name}...`);
143
144 const response = yield* Effect.gen(function* () {
145 const resp = yield* httpClient.get(asset.browser_download_url);
@@ -312,33 +313,40 @@ export class UpgradeBinary extends Effect.Service<UpgradeBinary>()('services/Upg
313 */
314 const upgrade = () =>
315 Effect.gen(function* () {
316 + const ui = yield* TerminalUI;
317 const upgradeTargetOpt = yield* DEBUG_OVERRIDE_CONFIG['UPGRADE_TARGET'];
318 const currentPath = yield* getCurrentExecutablePath();
319 yield* Effect.logDebug(`Current executable path: ${currentPath}`);
320
321 + yield* ui.intro('composio upgrade');
322 +
323 // If local binary path is provided (for testing), use it directly
324 if (Option.isSome(upgradeTargetOpt)) {
321 - yield* Console.log(`📦 New local version available (current: ${APP_VERSION})`);
325 + yield* ui.log.info(`New local version available (current: ${APP_VERSION})`);
326 yield* replaceBinary(upgradeTargetOpt.value, currentPath);
327 + yield* ui.outro('Upgrade completed');
328 return;
329 }
330
326 - yield* Console.log('Checking for updates...');
331 + const spinner = yield* ui.makeSpinner('Checking for updates...');
332
333 const release = yield* fetchLatestRelease();
334 const updateAvailable = yield* isUpdateAvailable(release);
335 if (!updateAvailable) {
331 - yield* Console.log('✅ You are already running the latest version!');
336 + yield* spinner.stop('You are already running the latest version!');
337 + yield* ui.outro('');
338 return;
339 }
340
335 - yield* Console.log(
336 - `📦 New version available: ${release.tag_name} (current: ${APP_VERSION})`
341 + yield* spinner.message(
342 + `New version available: ${release.tag_name} (current: ${APP_VERSION}). Downloading...`
343 );
344
345 const platformArch = yield* detectPlatform;
346 const { name, data } = yield* downloadBinary(release, platformArch);
347
348 + yield* spinner.message('Extracting...');
349 +
350 // The temporary directory is automatically cleaned up
351 const tmpDir = yield* fs
352 .makeTempDirectoryScoped({ prefix: `${CLI_BINARY_NAME}-upgrade}` })
@@ -356,7 +364,8 @@ export class UpgradeBinary extends Effect.Service<UpgradeBinary>()('services/Upg
364 const extractedBinaryPath = yield* extractBinary({ name, data }, tmpDir);
365 yield* replaceBinary(extractedBinaryPath, currentPath);
366
359 - yield* Console.log(`🎉 Upgrade completed! Restart your terminal to use the new version.`);
367 + yield* spinner.stop('Upgrade completed!');
368 + yield* ui.outro('Restart your terminal to use the new version.');
369 });
370
371 return {
ts/packages/cli/test/__utils__/services/terminal-ui-test.ts new
+48
@@ -0,0 +1,48 @@
1 +import { Console, Effect, Layer } from 'effect';
2 +import { TerminalUI } from 'src/services/terminal-ui';
3 +
4 +/**
5 + * Test layer for TerminalUI that routes all output through Effect's Console.
6 + * Since tests use MockConsole (which intercepts Console), this ensures
7 + * all terminal UI output is captured deterministically — no animations,
8 + * no ANSI codes, no spinners.
9 + */
10 +export const TerminalUITest = Layer.succeed(
11 + TerminalUI,
12 + TerminalUI.of({
13 + intro: title => Console.log(`-- ${title} --`),
14 + outro: message => Console.log(`-- ${message} --`),
15 +
16 + log: {
17 + info: message => Console.log(message),
18 + success: message => Console.log(message),
19 + warn: message => Console.warn(message),
20 + error: message => Console.error(message),
21 + step: message => Console.log(message),
22 + message: message => Console.log(message),
23 + },
24 +
25 + note: (message, title) => Console.log(title ? `[${title}] ${message}` : message),
26 +
27 + withSpinner: (message, effect, options) =>
28 + Effect.gen(function* () {
29 + const result = yield* effect;
30 + const successMsg =
31 + typeof options?.successMessage === 'function'
32 + ? options.successMessage(result)
33 + : (options?.successMessage ?? message);
34 + yield* Console.log(successMsg);
35 + return result;
36 + }),
37 +
38 + makeSpinner: message =>
39 + Effect.gen(function* () {
40 + void message;
41 + return {
42 + message: (_msg: string) => Effect.void,
43 + stop: (msg?: string) => (msg ? Console.log(msg) : Effect.void),
44 + error: (msg?: string) => (msg ? Console.error(msg) : Effect.void),
45 + };
46 + }),
47 + })
48 +);
ts/packages/cli/test/__utils__/services/test-layer.ts
+3 -1
@@ -17,6 +17,7 @@ import {
17 import { ComposioCliConfig } from 'src/cli-config';
18 import * as MockConsole from './mock-console';
19 import * as MockTerminal from './mock-terminal';
20 +import { TerminalUITest } from './terminal-ui-test';
21 import type { Toolkits } from 'src/models/toolkits';
22 import { NodeProcess } from 'src/services/node-process';
23 import {
@@ -263,7 +264,8 @@ export const TestLayer = (input?: TestLiveInput) =>
264 BunFileSystem.layer,
265 BunContext.layer,
266 MockTerminal.layer,
266 - BunPath.layer
267 + BunPath.layer,
268 + TerminalUITest
269 ) satisfies RequiredLayer;
270
271 return layers;
ts/packages/cli/test/src/commands/generate.cmd.test.ts
-2
@@ -85,7 +85,6 @@ describe('CLI: composio generate', () => {
85 const lines = yield* MockConsole.getLines();
86 const output = lines.join('\n');
87 expect(output).toContain('Project type detected: TypeScript');
88 - expect(output).toContain('Filtering to 1 toolkit(s): gmail');
88
89 // Check generated files - only gmail.ts should exist
90 const files = yield* fs.readDirectory(outputDir);
@@ -118,7 +117,6 @@ describe('CLI: composio generate', () => {
117 const lines = yield* MockConsole.getLines();
118 const output = lines.join('\n');
119 expect(output).toContain('Project type detected: Python');
121 - expect(output).toContain('Filtering to 1 toolkit(s): gmail');
120
121 // Check generated files - only gmail.py should exist
122 const files = yield* fs.readDirectory(outputDir);
ts/packages/cli/test/src/commands/whoami.cmd.test.ts
+2 -2
@@ -16,7 +16,7 @@ describe('CLI: composio whoami', () => {
16
17 const lines = yield* MockConsole.getLines();
18 const output = lines.join('\n');
19 - expect(output).toContain(`API KEY: api_key_from_test_config_provider`);
19 + expect(output).toContain(`api_key_from_test_config_provider`);
20 })
21 );
22 });
@@ -29,7 +29,7 @@ describe('CLI: composio whoami', () => {
29
30 const lines = yield* MockConsole.getLines();
31 const output = lines.join('\n');
32 - expect(output).toContain(`API KEY: api_key_from_test_fixture`);
32 + expect(output).toContain(`api_key_from_test_fixture`);
33 })
34 );
35 });
ts/vendor/clack new
+1
@@ -0,0 +1 @@
1 +Subproject commit 667572b221380cca0c5b02e31c165c3570c059ce