Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

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

jkomynoa5fa8a14700d
diff --git a/.gitmodules b/.gitmodules
index c3be0f027..9b715c76d 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -2,3 +2,6 @@
path = ts/vendor/effect
url = [email protected]:Effect-TS/effect.git
branch = main
+[submodule "ts/vendor/clack"]
+ path = ts/vendor/clack
+ url = https://github.com/bombshell-dev/clack.git
diff --git a/CLAUDE.md b/CLAUDE.md
index 099779d51..2f29dae6c 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -25,6 +25,21 @@ When working on CLI code, reference the Effect source for accurate patterns:
**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`.
+## Clack Reference Source
+
+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:
+
+- **Location:** `ts/vendor/clack/`
+- **Repo:** [bombshell-dev/clack](https://github.com/bombshell-dev/clack)
+
+When working on CLI prompts and terminal UI, reference the Clack source for accurate APIs:
+- `ts/vendor/clack/packages/prompts/src/` — `@clack/prompts` (high-level API: text, select, confirm, spinner, etc.)
+- `ts/vendor/clack/packages/core/src/` — `@clack/core` (low-level primitives)
+
+See `ts/packages/cli/AGENTS.md` for detailed Clack usage guidelines.
+
+**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`.
+
## Common Development Commands
### Build and Development
diff --git a/ts/packages/cli/src/bin.ts b/ts/packages/cli/src/bin.ts
index 551c8f160..34f163518 100644
--- a/ts/packages/cli/src/bin.ts
+++ b/ts/packages/cli/src/bin.ts
@@ -20,6 +20,7 @@ import { EnvLangDetector } from 'src/services/env-lang-detector';
import { JsPackageManagerDetector } from 'src/services/js-package-manager-detector';
import { ComposioUserContextLive as _ComposioUserContextLive } from 'src/services/user-context';
import { UpgradeBinary } from 'src/services/upgrade-binary';
+import { TerminalUILive } from 'src/services/terminal-ui';
/**
* Concrete Effect layer compositions for the Composio CLI runtime.
@@ -76,6 +77,7 @@ const layers = Layer.mergeAll(
JsPackageManagerDetector.Default,
BunContext.layer,
BunFileSystem.layer,
+ TerminalUILive,
Logger.pretty
) satisfies RequiredLayer;
diff --git a/ts/packages/cli/src/commands/generate.cmd.ts b/ts/packages/cli/src/commands/generate.cmd.ts
index 55b41ab13..795b299f3 100644
--- a/ts/packages/cli/src/commands/generate.cmd.ts
+++ b/ts/packages/cli/src/commands/generate.cmd.ts
@@ -1,7 +1,8 @@
import { Command, Options } from '@effect/cli';
-import { Effect, Console, Match } from 'effect';
+import { Effect, Match } from 'effect';
import { EnvLangDetector } from 'src/services/env-lang-detector';
import { NodeProcess } from 'src/services/node-process';
+import { TerminalUI } from 'src/services/terminal-ui';
import { generateTypescriptTypeStubs } from './ts/commands/ts.generate.cmd';
import { generatePythonTypeStubs } from './py/commands/py.generate.cmd';
@@ -37,13 +38,14 @@ export const generateCmd = Command.make('generate', { outputOpt, typeTools, tool
),
Command.withHandler(({ outputOpt, typeTools, toolkitsOpt }) =>
Effect.gen(function* () {
+ const ui = yield* TerminalUI;
const process = yield* NodeProcess;
const cwd = process.cwd;
yield* Effect.logDebug('Identifying project type...');
const envLangDetector = yield* EnvLangDetector;
const envLang = yield* envLangDetector.detectEnvLanguage(cwd);
- yield* Console.log(`Project type detected: ${envLang}`);
+ yield* ui.log.step(`Project type detected: ${envLang}`);
// Redirect to either `ts generate` or `py generate` commands
yield* Match.value(envLang).pipe(
diff --git a/ts/packages/cli/src/commands/login.cmd.ts b/ts/packages/cli/src/commands/login.cmd.ts
index 3fc7b1b3a..2cf3d5783 100644
--- a/ts/packages/cli/src/commands/login.cmd.ts
+++ b/ts/packages/cli/src/commands/login.cmd.ts
@@ -1,9 +1,9 @@
import { Command, Options } from '@effect/cli';
-import { Effect, Console, Schedule } from 'effect';
-import { green } from 'ansis';
+import { Effect, Schedule } from 'effect';
import open, { apps } from 'open';
import { ComposioSessionRepository } from 'src/services/composio-clients';
import { ComposioUserContext } from 'src/services/user-context';
+import { TerminalUI } from 'src/services/terminal-ui';
export const noBrowser = Options.boolean('no-browser').pipe(
Options.withDefault(false),
@@ -20,13 +20,17 @@ export const noBrowser = Options.boolean('no-browser').pipe(
*/
export const loginCmd = Command.make('login', { noBrowser }, ({ noBrowser }) =>
Effect.gen(function* () {
+ const ui = yield* TerminalUI;
const ctx = yield* ComposioUserContext;
+ yield* ui.intro('composio login');
+
if (ctx.isLoggedIn()) {
- yield* Console.log(`✔ You're already logged in!.`);
- yield* Console.log(
- `✔ If you want to log in with a different account, please run \`composio logout\` first.`
+ yield* ui.log.warn(`You're already logged in!`);
+ yield* ui.log.info(
+ `If you want to log in with a different account, please run \`composio logout\` first.`
);
+ yield* ui.outro('');
return;
}
@@ -41,12 +45,12 @@ export const loginCmd = Command.make('login', { noBrowser }, ({ noBrowser }) =>
const url = `${ctx.data.webURL}?cliKey=${session.id}`;
if (noBrowser) {
- yield* Console.log(`> Please login using the following URL:`);
+ yield* ui.log.info('Please login using the following URL:');
} else {
- yield* Console.log(`> Redirecting you to the login page`);
+ yield* ui.log.step('Redirecting you to the login page');
}
- yield* Console.log(green`> ${url}`);
+ yield* ui.note(url, 'Login URL');
if (!noBrowser) {
// Open the given `url` in the default browser
@@ -60,6 +64,9 @@ export const loginCmd = Command.make('login', { noBrowser }, ({ noBrowser }) =>
);
}
+ // Spinner during session polling
+ const spinner = yield* ui.makeSpinner('Waiting for login...');
+
// Retry operation until the session status is "linked" with exponential backoff
const linkedSession = yield* Effect.retry(
Effect.gen(function* () {
@@ -82,12 +89,15 @@ export const loginCmd = Command.make('login', { noBrowser }, ({ noBrowser }) =>
Schedule.intersect(Schedule.recurs(15)),
Schedule.intersect(Schedule.spaced('5 seconds'))
)
- );
+ ).pipe(Effect.tapError(() => spinner.error('Login timed out. Please try again.')));
+
+ yield* spinner.stop('Login successful');
yield* Effect.logDebug(`Linked session: ${JSON.stringify(linkedSession)}`);
yield* ctx.login(linkedSession.api_key);
- yield* Console.log(`Logged in with user account ${linkedSession.account.email}`);
+ yield* ui.log.success(`Logged in with user account ${linkedSession.account.email}`);
+ yield* ui.outro("You're all set!");
})
).pipe(Command.withDescription('Log in to the Composio SDK.'));
diff --git a/ts/packages/cli/src/commands/logout.cmd.ts b/ts/packages/cli/src/commands/logout.cmd.ts
index a35e30d36..2d6b47593 100644
--- a/ts/packages/cli/src/commands/logout.cmd.ts
+++ b/ts/packages/cli/src/commands/logout.cmd.ts
@@ -1,6 +1,7 @@
import { Command } from '@effect/cli';
-import { Effect, Console } from 'effect';
+import { Effect } from 'effect';
import { ComposioUserContext } from 'src/services/user-context';
+import { TerminalUI } from 'src/services/terminal-ui';
/**
* CLI command to log out from the Composio CLI.
@@ -12,14 +13,15 @@ import { ComposioUserContext } from 'src/services/user-context';
*/
export const logoutCmd = Command.make('logout', {}, () =>
Effect.gen(function* () {
+ const ui = yield* TerminalUI;
const ctx = yield* ComposioUserContext;
if (!ctx.isLoggedIn()) {
- yield* Console.log('You are not logged in yet. Please run `composio login`.');
+ yield* ui.log.warn('You are not logged in yet. Please run `composio login`.');
return;
}
yield* ctx.logout;
- yield* Console.log(`Logged out successfully.`);
+ yield* ui.log.success('Logged out successfully.');
})
).pipe(Command.withDescription('Log out from the Composio SDK.'));
diff --git a/ts/packages/cli/src/commands/py/commands/py.generate.cmd.ts b/ts/packages/cli/src/commands/py/commands/py.generate.cmd.ts
index 075034d12..66457c6b2 100644
--- a/ts/packages/cli/src/commands/py/commands/py.generate.cmd.ts
+++ b/ts/packages/cli/src/commands/py/commands/py.generate.cmd.ts
@@ -1,5 +1,5 @@
import { Command, Options } from '@effect/cli';
-import { pipe, Console, Effect, Option, Array } from 'effect';
+import { pipe, Effect, Option, Array } from 'effect';
import { FileSystem } from '@effect/platform';
import { ComposioToolkitsRepository } from 'src/services/composio-clients';
import { logMetrics } from 'src/effects/log-metrics';
@@ -14,6 +14,7 @@ import {
type ToolkitVersionOverrides,
} from 'src/effects/toolkit-version-overrides';
import { validateToolkitVersionOverrides } from 'src/effects/validate-toolkit-versions';
+import { TerminalUI } from 'src/services/terminal-ui';
export const outputOpt = Options.optional(
Options.directory('output-dir', {
@@ -47,11 +48,14 @@ export function generatePythonTypeStubs({
toolkitsOpt,
}: GetCmdParams<typeof _pyCmd$Generate>) {
return Effect.gen(function* () {
+ const ui = yield* TerminalUI;
const process = yield* NodeProcess;
const cwd = process.cwd;
const fs = yield* FileSystem.FileSystem;
const client = yield* ComposioToolkitsRepository;
+ yield* ui.intro('composio py generate');
+
// Determine the actual output directory
const outputDir = yield* outputOpt.pipe(
Option.match({
@@ -74,15 +78,13 @@ export function generatePythonTypeStubs({
const toolkitSlugsFilter = hasToolkitsFilter ? toolkitsOpt.map(s => s.toLowerCase()) : null;
// Validate toolkit version overrides before fetching data
- // This will log detected overrides, validate them against API, and warn about unused ones
const { validatedOverrides } = yield* validateToolkitVersionOverrides({
versionOverrides,
toolkitSlugsFilter,
client,
});
- // Fetch data from Composio API
- yield* Console.log('Fetching latest data from Composio API. This may take a while...');
+ const spinner = yield* ui.makeSpinner('Fetching data from Composio API...');
// Validate toolkit slugs if specified (separate from version validation)
const validatedToolkitSlugs = hasToolkitsFilter
@@ -117,8 +119,8 @@ export function generatePythonTypeStubs({
: allToolkits;
if (hasToolkitsFilter) {
- yield* Console.log(
- `Filtering to ${toolkits.length} toolkit(s): ${toolkits.map(t => t.slug).join(', ')}`
+ yield* spinner.message(
+ `Found ${toolkits.length} toolkit(s): ${toolkits.map(t => t.slug).join(', ')}`
);
}
@@ -133,6 +135,7 @@ export function generatePythonTypeStubs({
const typeableTools = { withTypes: false as const, tools };
+ yield* spinner.message('Generating Python type stubs...');
const index = createToolkitIndex({ toolkits, typeableTools, triggerTypes, versionMap });
// Generate Python sources
@@ -141,6 +144,8 @@ export function generatePythonTypeStubs({
outputDir,
})(index);
+ yield* spinner.message('Writing files to disk...');
+
// Write all generated files
yield* pipe(
Effect.all(
@@ -154,20 +159,21 @@ export function generatePythonTypeStubs({
Effect.mapError(error => new Error(`Failed to write generated files: ${error}`))
);
+ yield* spinner.stop('Type stubs generated successfully');
+
yield* Option.isNone(outputOpt)
- ? Console.log(
- '✅ Type stubs generated successfully.\n' +
- 'You can now import generated types via `from composio.generated.<toolkit_name> import <TOOLKIT_NAME>`.\n'
+ ? ui.note(
+ 'from composio.generated.<toolkit_name> import <TOOLKIT_NAME>',
+ 'Import your generated types'
)
- : Console.log(
- `✅ Type stubs generated successfully.\n` +
- `Generated files are available at: ${outputDir}`
- );
+ : ui.log.info(`Generated files are available at: ${outputDir}`);
// Log API metrics
const metrics = yield* client.getMetrics();
yield* logMetrics(metrics);
+ yield* ui.outro('Done');
+
return outputDir;
});
}
diff --git a/ts/packages/cli/src/commands/ts/commands/ts.generate.cmd.ts b/ts/packages/cli/src/commands/ts/commands/ts.generate.cmd.ts
index 6508fdd21..8015978cd 100644
--- a/ts/packages/cli/src/commands/ts/commands/ts.generate.cmd.ts
+++ b/ts/packages/cli/src/commands/ts/commands/ts.generate.cmd.ts
@@ -17,7 +17,7 @@
import path from 'node:path';
import { Command, Options } from '@effect/cli';
-import { Console, Effect, Option, pipe, Array } from 'effect';
+import { Effect, Option, pipe, Array } from 'effect';
import { Match } from 'effect';
import { FileSystem } from '@effect/platform';
import { ComposioToolkitsRepository } from 'src/services/composio-clients';
@@ -39,6 +39,7 @@ import {
type ToolkitVersionOverrides,
} from 'src/effects/toolkit-version-overrides';
import { validateToolkitVersionOverrides } from 'src/effects/validate-toolkit-versions';
+import { TerminalUI, type SpinnerHandle } from 'src/services/terminal-ui';
export const outputOpt = Options.optional(
Options.directory('output-dir', {
@@ -109,10 +110,11 @@ function fetchFilteredData(
client: ComposioToolkitsRepository,
slugs: ReadonlyArray<string>,
typeTools: boolean,
- versionOverrides: ToolkitVersionOverrides
+ versionOverrides: ToolkitVersionOverrides,
+ spinner: SpinnerHandle
): Effect.Effect<FetchResult, Error, never> {
return Effect.gen(function* () {
- yield* Console.log(`Fetching data for ${slugs.length} toolkit(s): ${slugs.join(', ')}...`);
+ yield* spinner.message(`Fetching data for ${slugs.length} toolkit(s): ${slugs.join(', ')}...`);
// Build version specs for each requested toolkit
const versionSpecs = buildToolkitVersionSpecs(slugs, versionOverrides);
@@ -167,8 +169,8 @@ function fetchFilteredData(
{ concurrency: 'unbounded' }
);
- yield* Console.log(
- `Filtering to ${filteredToolkits.length} toolkit(s): ${filteredToolkits.map(t => t.slug).join(', ')}`
+ yield* spinner.message(
+ `Found ${filteredToolkits.length} toolkit(s): ${filteredToolkits.map(t => t.slug).join(', ')}`
);
return {
@@ -186,7 +188,8 @@ function fetchFilteredData(
*/
function fetchAllDataFastPath(
client: ComposioToolkitsRepository,
- typeTools: boolean
+ typeTools: boolean,
+ spinner: SpinnerHandle
): Effect.Effect<FetchResult, Error, never> {
return Effect.gen(function* () {
// Fetch all data in parallel
@@ -218,7 +221,7 @@ function fetchAllDataFastPath(
{ concurrency: 'unbounded' }
);
- yield* Console.log(`Found ${allToolkits.length} toolkit(s)`);
+ yield* spinner.message(`Found ${allToolkits.length} toolkit(s)`);
return {
toolkits: allToolkits,
@@ -236,7 +239,8 @@ function fetchAllDataFastPath(
function fetchAllDataWithOverrides(
client: ComposioToolkitsRepository,
typeTools: boolean,
- versionOverrides: ToolkitVersionOverrides
+ versionOverrides: ToolkitVersionOverrides,
+ spinner: SpinnerHandle
): Effect.Effect<FetchResult, Error, never> {
return Effect.gen(function* () {
// 1. First fetch all toolkit metadata to know what's available
@@ -277,7 +281,7 @@ function fetchAllDataWithOverrides(
{ concurrency: 'unbounded' }
);
- yield* Console.log(`Found ${allToolkits.length} toolkit(s)`);
+ yield* spinner.message(`Found ${allToolkits.length} toolkit(s)`);
return {
toolkits: allToolkits,
@@ -295,16 +299,17 @@ function fetchAllDataWithOverrides(
function fetchAllData(
client: ComposioToolkitsRepository,
typeTools: boolean,
- versionOverrides: ToolkitVersionOverrides
+ versionOverrides: ToolkitVersionOverrides,
+ spinner: SpinnerHandle
): Effect.Effect<FetchResult, Error, never> {
return Effect.gen(function* () {
- yield* Console.log('Fetching all toolkits, tools, and triggers from Composio API...');
+ yield* spinner.message('Fetching all toolkits, tools, and triggers...');
if (versionOverrides.size === 0) {
- return yield* fetchAllDataFastPath(client, typeTools);
+ return yield* fetchAllDataFastPath(client, typeTools, spinner);
}
- return yield* fetchAllDataWithOverrides(client, typeTools, versionOverrides);
+ return yield* fetchAllDataWithOverrides(client, typeTools, versionOverrides, spinner);
});
}
@@ -350,11 +355,14 @@ export function generateTypescriptTypeStubs({
toolkitsOpt,
}: GetCmdParams<typeof _tsCmd$Generate> & { transpiled?: boolean }) {
return Effect.gen(function* () {
+ const ui = yield* TerminalUI;
const fs = yield* FileSystem.FileSystem;
const process = yield* NodeProcess;
const cwd = process.cwd;
const client = yield* ComposioToolkitsRepository;
+ yield* ui.intro('composio ts generate');
+
// Determine the actual output directory
const outputDir = yield* outputOpt.pipe(
Option.match({
@@ -385,12 +393,14 @@ export function generateTypescriptTypeStubs({
client,
});
- // Fetch data using two distinct strategies based on whether --toolkits filter is provided
+ // Fetch data using a spinner for progress
+ const spinner = yield* ui.makeSpinner('Fetching data from Composio API...');
+
const { toolkits, triggerTypes, typeableTools, versionMap } = yield* toolkitSlugsFilter !== null
- ? fetchFilteredData(client, toolkitSlugsFilter, typeTools, validatedOverrides)
- : fetchAllData(client, typeTools, validatedOverrides);
+ ? fetchFilteredData(client, toolkitSlugsFilter, typeTools, validatedOverrides, spinner)
+ : fetchAllData(client, typeTools, validatedOverrides, spinner);
- yield* Console.log('Writing TypeScript type stubs to disk...');
+ yield* spinner.message('Generating TypeScript type stubs...');
const index = createToolkitIndex({ toolkits, typeableTools, triggerTypes, versionMap });
// Generate TypeScript sources
@@ -401,6 +411,8 @@ export function generateTypescriptTypeStubs({
importExtension: 'js',
})(index);
+ yield* spinner.message('Writing files to disk...');
+
// Write all generated files
yield* pipe(
Effect.all(
@@ -416,6 +428,7 @@ export function generateTypescriptTypeStubs({
// Compile TypeScript to JavaScript if needed
if (transpiled) {
+ yield* spinner.message('Transpiling to JavaScript...');
yield* pipe(
transpileTypeScriptSources({ sources, outputDir }),
Effect.catchAll(error =>
@@ -424,20 +437,21 @@ export function generateTypescriptTypeStubs({
);
}
+ yield* spinner.stop('Type stubs generated successfully');
+
yield* Option.isNone(outputOpt)
- ? Console.log(
- '✅ Type stubs generated successfully.\n' +
- 'You can now import generated types via `import { Toolkits } from "@composio/core/generated"`'
+ ? ui.note(
+ 'import { Toolkits } from "@composio/core/generated"',
+ 'Import your generated types'
)
- : Console.log(
- `✅ Type stubs generated successfully.\n` +
- `Generated files are available at: ${outputDir}`
- );
+ : ui.log.info(`Generated files are available at: ${outputDir}`);
// Log API metrics
const metrics = yield* client.getMetrics();
yield* logMetrics(metrics);
+ yield* ui.outro('Done');
+
return outputDir;
});
}
diff --git a/ts/packages/cli/src/commands/version.cmd.ts b/ts/packages/cli/src/commands/version.cmd.ts
index dbcc2b073..8356c2204 100644
--- a/ts/packages/cli/src/commands/version.cmd.ts
+++ b/ts/packages/cli/src/commands/version.cmd.ts
@@ -1,6 +1,7 @@
import { Command } from '@effect/cli';
-import { Effect, Console } from 'effect';
+import { Effect } from 'effect';
import { getVersion } from 'src/effects/version';
+import { TerminalUI } from 'src/services/terminal-ui';
/**
* CLI command to display the version of the Composio CLI.
@@ -14,8 +15,9 @@ export const versionCmd = Command.make('version', {}).pipe(
Command.withDescription('Display your account information.'),
Command.withHandler(() =>
Effect.gen(function* () {
+ const ui = yield* TerminalUI;
const version = yield* getVersion;
- yield* Console.log(`${version}`);
+ yield* ui.log.info(version);
yield* Effect.logDebug('Composio CLI version command executed successfully.');
})
diff --git a/ts/packages/cli/src/commands/whoami.cmd.ts b/ts/packages/cli/src/commands/whoami.cmd.ts
index e06fd29a5..9c5bf9501 100644
--- a/ts/packages/cli/src/commands/whoami.cmd.ts
+++ b/ts/packages/cli/src/commands/whoami.cmd.ts
@@ -1,6 +1,7 @@
import { Command } from '@effect/cli';
-import { Effect, Console, Option } from 'effect';
+import { Effect, Option } from 'effect';
import { ComposioUserContext } from 'src/services/user-context';
+import { TerminalUI } from 'src/services/terminal-ui';
/**
* CLI command to display your account information.
@@ -14,16 +15,15 @@ export const whoamiCmd = Command.make('whoami', {}).pipe(
Command.withDescription('Display your account information.'),
Command.withHandler(() =>
Effect.gen(function* () {
+ const ui = yield* TerminalUI;
const ctx = yield* ComposioUserContext;
- const message = ctx.data.apiKey.pipe(
+ yield* ctx.data.apiKey.pipe(
Option.match({
- onNone: () => 'You are not logged in yet. Please run `composio login`.',
- onSome: apiKey => `API KEY: ${apiKey}`,
+ onNone: () => ui.log.warn('You are not logged in yet. Please run `composio login`.'),
+ onSome: apiKey => ui.note(apiKey, 'API Key'),
})
);
-
- yield* Console.log(message);
})
)
);
diff --git a/ts/packages/cli/src/effects/validate-toolkit-versions.ts b/ts/packages/cli/src/effects/validate-toolkit-versions.ts
index 88c24cba1..929e57f63 100644
--- a/ts/packages/cli/src/effects/validate-toolkit-versions.ts
+++ b/ts/packages/cli/src/effects/validate-toolkit-versions.ts
@@ -1,6 +1,7 @@
-import { Console, Effect } from 'effect';
+import { Effect } from 'effect';
import colors from 'picocolors';
import { S_BAR, unicodeOr } from '@clack/prompts';
+import { TerminalUI } from 'src/services/terminal-ui';
import type {
ComposioToolkitsRepository,
InvalidVersionDetail,
@@ -140,20 +141,20 @@ export const validateToolkitVersionOverrides = ({
versionOverrides,
toolkitSlugsFilter,
client,
-}: ValidateVersionsOptions): Effect.Effect<ValidateVersionsResult, Error> =>
+}: ValidateVersionsOptions): Effect.Effect<ValidateVersionsResult, Error, TerminalUI> =>
Effect.gen(function* () {
+ const ui = yield* TerminalUI;
+
// Skip if no overrides
if (versionOverrides.size === 0) {
return { validatedOverrides: versionOverrides };
}
// Log detected overrides
- yield* Console.log('Detected toolkit version overrides:');
- for (const [toolkit, version] of versionOverrides) {
- yield* Console.log(` - ${toolkit}: ${version}`);
- }
-
- yield* Console.log('Validating toolkit version overrides...');
+ const overrideLines = [...versionOverrides]
+ .map(([toolkit, version]) => ` ${toolkit}: ${version}`)
+ .join('\n');
+ yield* ui.log.info(`Detected toolkit version overrides:\n${overrideLines}`);
const { validatedOverrides, warnings } = yield* client
.validateToolkitVersions(versionOverrides, toolkitSlugsFilter ?? undefined)
@@ -182,7 +183,7 @@ export const validateToolkitVersionOverrides = ({
// Log warnings for unused overrides
for (const warning of warnings) {
- yield* Console.warn(`Warning: ${warning}`);
+ yield* ui.log.warn(`${warning}`);
}
return { validatedOverrides };
diff --git a/ts/packages/cli/src/services/terminal-ui.ts b/ts/packages/cli/src/services/terminal-ui.ts
new file mode 100644
index 000000000..76bb206d2
--- /dev/null
+++ b/ts/packages/cli/src/services/terminal-ui.ts
@@ -0,0 +1,121 @@
+import * as p from '@clack/prompts';
+import { Context, Effect, Exit, Layer } from 'effect';
+
+// ---------------------------------------------------------------------------
+// SpinnerHandle — returned by `makeSpinner` for manual control
+// ---------------------------------------------------------------------------
+
+export interface SpinnerHandle {
+ /** Update the spinner message while it's running. */
+ readonly message: (msg: string) => Effect.Effect<void>;
+ /** Stop the spinner with a success message. */
+ readonly stop: (msg?: string) => Effect.Effect<void>;
+ /** Stop the spinner with an error message. */
+ readonly error: (msg?: string) => Effect.Effect<void>;
+}
+
+// ---------------------------------------------------------------------------
+// TerminalUI — Effect service for structured terminal output
+// ---------------------------------------------------------------------------
+
+export interface TerminalUI {
+ /** Display a session start marker (e.g., `┌ title`). */
+ readonly intro: (title: string) => Effect.Effect<void>;
+ /** Display a session end marker (e.g., `└ message`). */
+ readonly outro: (message: string) => Effect.Effect<void>;
+
+ /** Structured log output with severity-specific symbols. */
+ readonly log: {
+ /** Blue info marker. */
+ readonly info: (message: string) => Effect.Effect<void>;
+ /** Green success marker. */
+ readonly success: (message: string) => Effect.Effect<void>;
+ /** Yellow warning marker. */
+ readonly warn: (message: string) => Effect.Effect<void>;
+ /** Red error marker. */
+ readonly error: (message: string) => Effect.Effect<void>;
+ /** Green step marker (for completed steps). */
+ readonly step: (message: string) => Effect.Effect<void>;
+ /** Generic log message with bar guide. */
+ readonly message: (message: string) => Effect.Effect<void>;
+ };
+
+ /** Display a boxed note with optional title. */
+ readonly note: (message: string, title?: string) => Effect.Effect<void>;
+
+ /**
+ * Wrap an Effect computation in a spinner.
+ * The spinner starts before the effect runs and stops/errors on completion.
+ */
+ readonly withSpinner: <A, E, R>(
+ message: string,
+ effect: Effect.Effect<A, E, R>,
+ options?: {
+ readonly successMessage?: string | ((result: A) => string);
+ readonly errorMessage?: string;
+ }
+ ) => Effect.Effect<A, E, R>;
+
+ /**
+ * Create a controllable spinner for multi-step flows (e.g., login polling).
+ * The caller is responsible for calling `stop()` or `error()`.
+ */
+ readonly makeSpinner: (message: string) => Effect.Effect<SpinnerHandle>;
+}
+
+export const TerminalUI = Context.GenericTag<TerminalUI>('services/TerminalUI');
+
+// ---------------------------------------------------------------------------
+// TerminalUILive — production layer using @clack/prompts
+// ---------------------------------------------------------------------------
+
+const makeLive: TerminalUI = {
+ intro: title => Effect.sync(() => p.intro(title)),
+ outro: message => Effect.sync(() => p.outro(message)),
+
+ log: {
+ info: message => Effect.sync(() => p.log.info(message)),
+ success: message => Effect.sync(() => p.log.success(message)),
+ warn: message => Effect.sync(() => p.log.warn(message)),
+ error: message => Effect.sync(() => p.log.error(message)),
+ step: message => Effect.sync(() => p.log.step(message)),
+ message: message => Effect.sync(() => p.log.message(message)),
+ },
+
+ note: (message, title) => Effect.sync(() => p.note(message, title ?? '')),
+
+ withSpinner: (message, effect, options) =>
+ Effect.acquireUseRelease(
+ Effect.sync(() => {
+ const s = p.spinner();
+ s.start(message);
+ return s;
+ }),
+ () => effect,
+ (s, exit) =>
+ Effect.sync(() => {
+ if (Exit.isSuccess(exit)) {
+ const successMsg =
+ typeof options?.successMessage === 'function'
+ ? options.successMessage(exit.value)
+ : (options?.successMessage ?? message);
+ s.stop(successMsg);
+ } else {
+ s.error(options?.errorMessage ?? message);
+ }
+ })
+ ),
+
+ makeSpinner: message =>
+ Effect.sync(() => {
+ const s = p.spinner();
+ s.start(message);
+ return {
+ message: (msg: string) => Effect.sync(() => s.message(msg)),
+ stop: (msg?: string) => Effect.sync(() => s.stop(msg ?? message)),
+ error: (msg?: string) => Effect.sync(() => s.error(msg ?? message)),
+ };
+ }),
+};
+
+export const TerminalUILive = Layer.succeed(TerminalUI, makeLive);
diff --git a/ts/packages/cli/src/services/upgrade-binary.ts b/ts/packages/cli/src/services/upgrade-binary.ts
index 47f8f081f..249f05421 100644
--- a/ts/packages/cli/src/services/upgrade-binary.ts
+++ b/ts/packages/cli/src/services/upgrade-binary.ts
@@ -1,4 +1,4 @@
-import { Data, Effect, Console, Config, Option } from 'effect';
+import { Data, Effect, Config, Option } from 'effect';
import { HttpClient, FileSystem } from '@effect/platform';
import * as path from 'node:path';
import { APP_VERSION } from '../constants';
@@ -11,6 +11,7 @@ import { CompareSemverError, semverComparator } from 'src/effects/compare-semver
import decompress from 'decompress';
import type { Predicate } from 'effect/Predicate';
import { renderPrettyError } from './utils/pretty-error';
+import { TerminalUI } from './terminal-ui';
export class UpgradeBinaryError extends Data.TaggedError('services/UpgradeBinaryError')<{
readonly cause?: unknown;
@@ -138,7 +139,7 @@ export class UpgradeBinary extends Effect.Service<UpgradeBinary>()('services/Upg
);
}
- yield* Console.log(`Downloading ${asset.name}...`);
+ yield* Effect.logDebug(`Downloading ${asset.name}...`);
const response = yield* Effect.gen(function* () {
const resp = yield* httpClient.get(asset.browser_download_url);
@@ -312,33 +313,40 @@ export class UpgradeBinary extends Effect.Service<UpgradeBinary>()('services/Upg
*/
const upgrade = () =>
Effect.gen(function* () {
+ const ui = yield* TerminalUI;
const upgradeTargetOpt = yield* DEBUG_OVERRIDE_CONFIG['UPGRADE_TARGET'];
const currentPath = yield* getCurrentExecutablePath();
yield* Effect.logDebug(`Current executable path: ${currentPath}`);
+ yield* ui.intro('composio upgrade');
+
// If local binary path is provided (for testing), use it directly
if (Option.isSome(upgradeTargetOpt)) {
- yield* Console.log(`📦 New local version available (current: ${APP_VERSION})`);
+ yield* ui.log.info(`New local version available (current: ${APP_VERSION})`);
yield* replaceBinary(upgradeTargetOpt.value, currentPath);
+ yield* ui.outro('Upgrade completed');
return;
}
- yield* Console.log('Checking for updates...');
+ const spinner = yield* ui.makeSpinner('Checking for updates...');
const release = yield* fetchLatestRelease();
const updateAvailable = yield* isUpdateAvailable(release);
if (!updateAvailable) {
- yield* Console.log('✅ You are already running the latest version!');
+ yield* spinner.stop('You are already running the latest version!');
+ yield* ui.outro('');
return;
}
- yield* Console.log(
- `📦 New version available: ${release.tag_name} (current: ${APP_VERSION})`
+ yield* spinner.message(
+ `New version available: ${release.tag_name} (current: ${APP_VERSION}). Downloading...`
);
const platformArch = yield* detectPlatform;
const { name, data } = yield* downloadBinary(release, platformArch);
+ yield* spinner.message('Extracting...');
+
// The temporary directory is automatically cleaned up
const tmpDir = yield* fs
.makeTempDirectoryScoped({ prefix: `${CLI_BINARY_NAME}-upgrade}` })
@@ -356,7 +364,8 @@ export class UpgradeBinary extends Effect.Service<UpgradeBinary>()('services/Upg
const extractedBinaryPath = yield* extractBinary({ name, data }, tmpDir);
yield* replaceBinary(extractedBinaryPath, currentPath);
- yield* Console.log(`🎉 Upgrade completed! Restart your terminal to use the new version.`);
+ yield* spinner.stop('Upgrade completed!');
+ yield* ui.outro('Restart your terminal to use the new version.');
});
return {
diff --git a/ts/packages/cli/test/__utils__/services/terminal-ui-test.ts b/ts/packages/cli/test/__utils__/services/terminal-ui-test.ts
new file mode 100644
index 000000000..9e68b552f
--- /dev/null
+++ b/ts/packages/cli/test/__utils__/services/terminal-ui-test.ts
@@ -0,0 +1,48 @@
+import { Console, Effect, Layer } from 'effect';
+import { TerminalUI } from 'src/services/terminal-ui';
+
+/**
+ * Test layer for TerminalUI that routes all output through Effect's Console.
+ * Since tests use MockConsole (which intercepts Console), this ensures
+ * all terminal UI output is captured deterministically — no animations,
+ * no ANSI codes, no spinners.
+ */
+export const TerminalUITest = Layer.succeed(
+ TerminalUI,
+ TerminalUI.of({
+ intro: title => Console.log(`-- ${title} --`),
+ outro: message => Console.log(`-- ${message} --`),
+
+ log: {
+ info: message => Console.log(message),
+ success: message => Console.log(message),
+ warn: message => Console.warn(message),
+ error: message => Console.error(message),
+ step: message => Console.log(message),
+ message: message => Console.log(message),
+ },
+
+ note: (message, title) => Console.log(title ? `[${title}] ${message}` : message),
+
+ withSpinner: (message, effect, options) =>
+ Effect.gen(function* () {
+ const result = yield* effect;
+ const successMsg =
+ typeof options?.successMessage === 'function'
+ ? options.successMessage(result)
+ : (options?.successMessage ?? message);
+ yield* Console.log(successMsg);
+ return result;
+ }),
+
+ makeSpinner: message =>
+ Effect.gen(function* () {
+ void message;
+ return {
+ message: (_msg: string) => Effect.void,
+ stop: (msg?: string) => (msg ? Console.log(msg) : Effect.void),
+ error: (msg?: string) => (msg ? Console.error(msg) : Effect.void),
+ };
+ }),
+ })
+);
diff --git a/ts/packages/cli/test/__utils__/services/test-layer.ts b/ts/packages/cli/test/__utils__/services/test-layer.ts
index 00d837ad8..aa7199a9a 100644
--- a/ts/packages/cli/test/__utils__/services/test-layer.ts
+++ b/ts/packages/cli/test/__utils__/services/test-layer.ts
@@ -17,6 +17,7 @@ import {
import { ComposioCliConfig } from 'src/cli-config';
import * as MockConsole from './mock-console';
import * as MockTerminal from './mock-terminal';
+import { TerminalUITest } from './terminal-ui-test';
import type { Toolkits } from 'src/models/toolkits';
import { NodeProcess } from 'src/services/node-process';
import {
@@ -263,7 +264,8 @@ export const TestLayer = (input?: TestLiveInput) =>
BunFileSystem.layer,
BunContext.layer,
MockTerminal.layer,
- BunPath.layer
+ BunPath.layer,
+ TerminalUITest
) satisfies RequiredLayer;
return layers;
diff --git a/ts/packages/cli/test/src/commands/generate.cmd.test.ts b/ts/packages/cli/test/src/commands/generate.cmd.test.ts
index 0b39dee19..a7b3a0b72 100644
--- a/ts/packages/cli/test/src/commands/generate.cmd.test.ts
+++ b/ts/packages/cli/test/src/commands/generate.cmd.test.ts
@@ -85,7 +85,6 @@ describe('CLI: composio generate', () => {
const lines = yield* MockConsole.getLines();
const output = lines.join('\n');
expect(output).toContain('Project type detected: TypeScript');
- expect(output).toContain('Filtering to 1 toolkit(s): gmail');
// Check generated files - only gmail.ts should exist
const files = yield* fs.readDirectory(outputDir);
@@ -118,7 +117,6 @@ describe('CLI: composio generate', () => {
const lines = yield* MockConsole.getLines();
const output = lines.join('\n');
expect(output).toContain('Project type detected: Python');
- expect(output).toContain('Filtering to 1 toolkit(s): gmail');
// Check generated files - only gmail.py should exist
const files = yield* fs.readDirectory(outputDir);
diff --git a/ts/packages/cli/test/src/commands/whoami.cmd.test.ts b/ts/packages/cli/test/src/commands/whoami.cmd.test.ts
index 27d0e4dfb..b5e91a699 100644
--- a/ts/packages/cli/test/src/commands/whoami.cmd.test.ts
+++ b/ts/packages/cli/test/src/commands/whoami.cmd.test.ts
@@ -16,7 +16,7 @@ describe('CLI: composio whoami', () => {
const lines = yield* MockConsole.getLines();
const output = lines.join('\n');
- expect(output).toContain(`API KEY: api_key_from_test_config_provider`);
+ expect(output).toContain(`api_key_from_test_config_provider`);
})
);
});
@@ -29,7 +29,7 @@ describe('CLI: composio whoami', () => {
const lines = yield* MockConsole.getLines();
const output = lines.join('\n');
- expect(output).toContain(`API KEY: api_key_from_test_fixture`);
+ expect(output).toContain(`api_key_from_test_fixture`);
})
);
});
diff --git a/ts/vendor/clack b/ts/vendor/clack
new file mode 160000
index 000000000..667572b22
--- /dev/null
+++ b/ts/vendor/clack
@@ -0,0 +1 @@
+Subproject commit 667572b221380cca0c5b02e31c165c3570c059ce