caroushell 0.1.23 → 0.1.29

package/README.md

@@ -64,6 +64,39 @@ OpenAI, etc.) will work as long as the URL, key, and model are valid. If you
 only provide a Gemini API key in the config, Caroushell will default to the
 Gemini Flash Lite 2.5 endpoint and model.
 
+## Prompt Display
+
+Caroushell can render a custom prompt using a template string in
+`~/.caroushell/config.toml`:
+
+```toml
+prompt = "{hostname} {short-directory} $>"
+```
+
+Available tokens:
+
+- `{hostname}`
+- `{directory}`
+- `{short-directory}`
+
+Examples:
+
+```toml
+prompt = "$> "
+```
+
+```toml
+prompt = "{directory} $> "
+```
+
+```toml
+prompt = "{hostname} {short-directory} $>"
+```
+
+`{short-directory}` keeps the final directory name and shortens parent
+directories to their first letter. For example, `/home/user/projects/my-app`
+becomes `/h/u/p/my-app`.
+
 ## Installation
 
 Install globally (recommended):

package/dist/app.js

@@ -5,7 +5,6 @@ const terminal_1 = require("./terminal");
 const keyboard_1 = require("./keyboard");
 const carousel_1 = require("./carousel");
 const history_suggester_1 = require("./history-suggester");
-const ai_suggester_1 = require("./ai-suggester");
 const file_suggester_1 = require("./file-suggester");
 const spawner_1 = require("./spawner");
 const logs_1 = require("./logs");
@@ -18,15 +17,16 @@ class App {
         this.terminal = deps.terminal ?? new terminal_1.Terminal();
         this.keyboard = deps.keyboard ?? new keyboard_1.Keyboard();
         this.history = deps.topPanel ?? new history_suggester_1.HistorySuggester();
-        this.ai = deps.bottomPanel ?? new ai_suggester_1.AISuggester();
+        this.bottomSuggester = deps.bottomPanel ?? new carousel_1.NullSuggester();
         this.files = deps.files ?? new file_suggester_1.FileSuggester();
-        this.suggesters = deps.suggesters ?? [this.history, this.ai, this.files];
+        this.suggesters = deps.suggesters ?? [this.history, this.bottomSuggester, this.files];
         this.carousel = new carousel_1.Carousel({
             top: this.history,
-            bottom: this.ai,
+            bottom: this.bottomSuggester,
             topRows: 2,
-            bottomRows: 2,
+            bottomRows: this.bottomSuggester instanceof carousel_1.NullSuggester ? 0 : 2,
             terminal: this.terminal,
+            promptLine0: deps.promptLine0,
         });
         this.queueUpdateSuggestions = () => {
             void this.carousel.updateSuggestions();
@@ -137,9 +137,9 @@ class App {
         };
     }
     async init() {
-        await this.history.init();
-        await this.ai.init();
-        await this.files.init();
+        for (const s of this.suggesters) {
+            await s.init();
+        }
     }
     async run() {
         await this.init();
@@ -185,6 +185,7 @@ class App {
         this.terminal.write("\n");
         this.keyboard.disableCapture();
         this.terminal.disableWrites();
+        await this.preBroadcastCommand(cmd);
         try {
             const storeInHistory = await (0, spawner_1.runUserCommand)(cmd);
             if (storeInHistory) {
@@ -291,6 +292,19 @@ class App {
         this.usingFileSuggestions = true;
         this.carousel.setTopSuggester(this.files);
     }
+    async preBroadcastCommand(cmd) {
+        const listeners = this.suggesters
+            .map((suggester) => suggester.onCommandWillRun?.(cmd))
+            .filter(Boolean);
+        if (listeners.length === 0)
+            return;
+        try {
+            await Promise.all(listeners);
+        }
+        catch (err) {
+            (0, logs_1.logLine)("suggester onCommandWillRun error: " + err?.message);
+        }
+    }
     async broadcastCommand(cmd) {
         const listeners = this.suggesters
             .map((suggester) => suggester.onCommandRan?.(cmd))

package/dist/carousel.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Carousel = void 0;
+exports.Carousel = exports.NullSuggester = void 0;
 exports.getDisplayWidth = getDisplayWidth;
 const logs_1 = require("./logs");
 const terminal_1 = require("./terminal");
@@ -57,6 +57,16 @@ function getDisplayWidth(text) {
     }
     return width;
 }
+class NullSuggester {
+    constructor() {
+        this.prefix = "";
+    }
+    async init() { }
+    async refreshSuggestions() { }
+    latest() { return []; }
+    descriptionForAi() { return ""; }
+}
+exports.NullSuggester = NullSuggester;
 class Carousel {
     constructor(opts) {
         this.index = 0;
@@ -67,6 +77,7 @@ class Carousel {
         this.bottom = opts.bottom;
         this.topRowCount = opts.topRows;
         this.bottomRowCount = opts.bottomRows;
+        this.promptLine0Getter = opts.promptLine0 ?? (() => "$> ");
     }
     async updateSuggestions(input) {
         if (typeof input === "string") {
@@ -386,7 +397,7 @@ class Carousel {
         return start;
     }
     getPromptPrefix(lineIndex) {
-        return lineIndex === 0 ? "$> " : "> ";
+        return lineIndex === 0 ? this.promptLine0Getter() : "> ";
     }
     render() {
         (0, logs_1.logLine)("Rendering carousel");

package/dist/config.js

@@ -40,6 +40,7 @@ exports.configFolder = configFolder;
 exports.getConfigPath = getConfigPath;
 exports.doesConfigExist = doesConfigExist;
 exports.getConfig = getConfig;
+exports.buildPromptLine0 = buildPromptLine0;
 const fs_1 = require("fs");
 const path = __importStar(require("path"));
 const os = __importStar(require("os"));
@@ -88,7 +89,6 @@ async function doesConfigExist() {
     }
 }
 async function getConfig() {
-    const configPath = getConfigPath();
     const raw = await readConfigFile();
     const envApiKey = process.env.CAROUSHELL_API_KEY || process.env.GEMINI_API_KEY || undefined;
     const envApiUrl = process.env.CAROUSHELL_API_URL || undefined;
@@ -107,9 +107,6 @@ async function getConfig() {
     if (!resolved.model && geminiApiKey) {
         resolved.model = GEMINI_DEFAULT_MODEL;
     }
-    if (!resolved.apiUrl || !resolved.apiKey || !resolved.model) {
-        throw new Error(`Config at ${configPath} is missing required fields. Please include apiUrl, apiKey, and model (or just GEMINI_API_KEY).`);
-    }
     return resolved;
 }
 function isGeminiUrl(url) {
@@ -117,3 +114,35 @@ function isGeminiUrl(url) {
     return (lower.includes("generativelanguage.googleapis.com") ||
         lower.includes("gemini"));
 }
+function normalizeCwd(cwd) {
+    const normalized = cwd.replace(/\\/g, "/");
+    const home = os.homedir().replace(/\\/g, "/");
+    if (normalized === home)
+        return "~";
+    if (normalized.startsWith(home + "/")) {
+        return "~" + normalized.slice(home.length);
+    }
+    return normalized;
+}
+function shortenPath(p) {
+    const parts = p.split("/");
+    return parts
+        .map((part, i) => {
+        if (i === parts.length - 1)
+            return part;
+        if (part === "" || part === "~")
+            return part;
+        return part[0];
+    })
+        .join("/");
+}
+function buildPromptLine0(config) {
+    return () => {
+        const normalized = normalizeCwd(process.cwd());
+        const template = config.prompt ?? "$> ";
+        return template
+            .replace(/\{hostname\}/g, os.hostname())
+            .replace(/\{directory\}/g, normalized)
+            .replace(/\{short-directory\}/g, shortenPath(normalized));
+    };
+}

package/dist/hello-new-user.js

@@ -42,6 +42,42 @@ const path = __importStar(require("path"));
 const readline_1 = __importDefault(require("readline"));
 const ai_suggester_1 = require("./ai-suggester");
 const preferredModels = ["gemini-2.5-flash-lite", "gpt-4o-mini"];
+const defaultPromptTemplate = "$> ";
+function serializeToml(obj) {
+    const lines = [];
+    const sections = [];
+    for (const [key, value] of Object.entries(obj)) {
+        if (value !== undefined && typeof value === "object" && value !== null) {
+            sections.push([key, value]);
+        }
+        else if (value !== undefined) {
+            lines.push(`${key} = ${JSON.stringify(value)}`);
+        }
+    }
+    for (const [section, values] of sections) {
+        lines.push(`\n[${section}]`);
+        for (const [key, value] of Object.entries(values)) {
+            if (value !== undefined) {
+                lines.push(`${key} = ${JSON.stringify(value)}`);
+            }
+        }
+    }
+    return lines.join("\n");
+}
+async function askPromptConfig(prompter, logFn) {
+    logFn("Customize your shell prompt with plain text and tokens.");
+    logFn("Available tokens:");
+    logFn("  {hostname}");
+    logFn("  {directory}");
+    logFn("  {short-directory}");
+    logFn(`Press Enter to keep the default prompt: ${defaultPromptTemplate}`);
+    const answer = await prompter.ask("Prompt template: ");
+    const trimmed = answer.trim();
+    if (!trimmed || trimmed === defaultPromptTemplate.trim()) {
+        return undefined;
+    }
+    return answer;
+}
 function isInteractive() {
     return Boolean(process.stdin.isTTY && process.stdout.isTTY);
 }
@@ -50,6 +86,25 @@ async function prompt(question, rl) {
         rl.question(question, (answer) => resolve(answer));
     });
 }
+function createReadlineTerminal() {
+    return {
+        createPrompter() {
+            const rl = readline_1.default.createInterface({
+                input: process.stdin,
+                output: process.stdout,
+            });
+            return {
+                ask(question) {
+                    return prompt(question, rl);
+                },
+                close() {
+                    rl.close();
+                },
+            };
+        },
+        isInteractive,
+    };
+}
 function findShortestMatches(models, preferredList) {
     const matches = [];
     for (const pref of preferredList) {
@@ -61,82 +116,94 @@ function findShortestMatches(models, preferredList) {
     }
     return [...new Set(matches)];
 }
-async function runHelloNewUserFlow(configPath) {
-    if (!isInteractive()) {
+async function runHelloNewUserFlow(configPath, deps = {}) {
+    const fileSystem = deps.fsOps ?? fs_1.promises;
+    const listModelsFn = deps.listModelsFn ?? ai_suggester_1.listModels;
+    const logFn = deps.logFn ?? console.log;
+    const terminal = deps.terminal ?? createReadlineTerminal();
+    if (!terminal.isInteractive()) {
         throw new Error(`Missing config at ${configPath} and no interactive terminal is available.\n` +
             "Create the file manually or run Caroushell from a TTY.");
     }
     const dir = path.dirname(configPath);
-    await fs_1.promises.mkdir(dir, { recursive: true });
-    console.log("");
-    console.log("Welcome to Caroushell!");
-    console.log(`Let's set up AI suggestions. You'll need an API endpoint URL, a key, and model id. These will be stored at ${configPath}`);
-    console.log("");
-    console.log("Some example endpoints you can paste:");
-    console.log("  - OpenRouter: https://openrouter.ai/api/v1");
-    console.log("  - OpenAI:     https://api.openai.com/v1");
-    console.log("  - Google:     https://generativelanguage.googleapis.com/v1beta/openai");
-    console.log("");
-    console.log("Press Ctrl+C any time to abort.\n");
-    const rl = readline_1.default.createInterface({
-        input: process.stdin,
-        output: process.stdout,
-    });
+    await fileSystem.mkdir(dir, { recursive: true });
+    logFn("");
+    logFn("Welcome to Caroushell!");
+    logFn("");
+    const prompter = terminal.createPrompter();
+    const promptConfig = await askPromptConfig(prompter, logFn);
+    const wantsAi = (await prompter.ask("Do you want to set up AI auto-complete? (y/n): "))
+        .trim()
+        .toLowerCase();
+    if (wantsAi !== "y" && wantsAi !== "yes") {
+        prompter.close();
+        const config = { noAi: true, prompt: promptConfig };
+        await fileSystem.writeFile(configPath, serializeToml(config) + "\n", "utf8");
+        logFn("\nSkipping AI setup. You can set it up later by editing " + configPath);
+        logFn("");
+        return null;
+    }
+    logFn(`\nLet's set up AI suggestions. You'll need an API endpoint URL, a key, and model id. These will be stored at ${configPath}`);
+    logFn("");
+    logFn("Some example endpoints you can paste:");
+    logFn("  - OpenRouter: https://openrouter.ai/api/v1");
+    logFn("  - OpenAI:     https://api.openai.com/v1");
+    logFn("  - Google:     https://generativelanguage.googleapis.com/v1beta/openai");
+    logFn("");
+    logFn("Press Ctrl+C any time to abort.\n");
     let apiUrl = "";
     while (!apiUrl) {
-        const answer = (await prompt("API URL: ", rl)).trim();
+        const answer = (await prompter.ask("API URL: ")).trim();
         if (answer) {
             apiUrl = answer;
         }
         else {
-            console.log("Please enter a URL (example: https://openrouter.ai/api/v1)");
+            logFn("Please enter a URL (example: https://openrouter.ai/api/v1)");
         }
     }
     let apiKey = "";
     while (!apiKey) {
-        const answer = (await prompt("API key: ", rl)).trim();
+        const answer = (await prompter.ask("API key: ")).trim();
         if (answer) {
             apiKey = answer;
         }
         else {
-            console.log("Please enter an API key. The value is stored in the local config file.");
+            logFn("Please enter an API key. The value is stored in the local config file.");
         }
     }
-    const models = await (0, ai_suggester_1.listModels)(apiUrl, apiKey);
+    const models = await listModelsFn(apiUrl, apiKey);
     if (models.length > 0) {
         const preferred = findShortestMatches(models, preferredModels);
-        console.log("Here are a few example model ids from your api service. Choose a fast and cheap model because AI suggestions happen as you type.");
+        logFn("Here are a few example model ids from your api service. Choose a fast and cheap model because AI suggestions happen as you type.");
         for (const model of models.slice(0, 5)) {
-            console.log(`  - ${model}`);
+            logFn(`  - ${model}`);
         }
         if (preferred.length) {
-            console.log("Recommended models from your provider:");
+            logFn("Recommended models from your provider:");
             for (const model of preferred) {
-                console.log(`  - ${model}`);
+                logFn(`  - ${model}`);
             }
         }
     }
     let model = "";
     while (!model) {
-        const answer = (await prompt("Model id: ", rl)).trim();
+        const answer = (await prompter.ask("Model id: ")).trim();
         if (answer) {
             model = answer;
         }
         else {
-            console.log("Please enter a model id (example: google/gemini-2.5-flash-lite, mistralai/mistral-small-24b-instruct-2501).");
+            logFn("Please enter a model id (example: google/gemini-2.5-flash-lite, mistralai/mistral-small-24b-instruct-2501).");
         }
     }
-    rl.close();
+    prompter.close();
     const config = {
         apiUrl,
         apiKey,
         model,
+        prompt: promptConfig,
     };
-    const tomlBody = Object.entries(config)
-        .map(([key, value]) => `${key} = ${JSON.stringify(value)}`)
-        .join("\n");
-    await fs_1.promises.writeFile(configPath, tomlBody + "\n", "utf8");
-    console.log(`\nSaved config to ${configPath}`);
-    console.log("You can edit this file later if you want to switch providers.\n");
+    await fileSystem.writeFile(configPath, serializeToml(config) + "\n", "utf8");
+    logFn(`\nSaved config to ${configPath}`);
+    logFn("You can edit this file later if you want to switch providers.\n");
     return config;
 }

package/dist/history-suggester.js

@@ -48,9 +48,10 @@ class HistorySuggester {
             .catch(() => { });
         await fs_1.promises.appendFile(this.filePath, this.serializeHistoryEntry(command), "utf8");
     }
-    async onCommandRan(command) {
+    async onCommandWillRun(command) {
         await this.add(command);
     }
+    async onCommandRan(command) { }
     latest() {
         return this.filteredItems;
     }

package/dist/main.js

@@ -4,6 +4,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = require("fs");
 const path_1 = require("path");
 const app_1 = require("./app");
+const ai_suggester_1 = require("./ai-suggester");
+const carousel_1 = require("./carousel");
 const hello_new_user_1 = require("./hello-new-user");
 const logs_1 = require("./logs");
 const config_1 = require("./config");
@@ -25,7 +27,11 @@ async function main() {
     if (!(await (0, config_1.doesConfigExist)())) {
         await (0, hello_new_user_1.runHelloNewUserFlow)((0, config_1.getConfigPath)());
     }
-    const app = new app_1.App();
+    const config = await (0, config_1.getConfig)();
+    const bottomPanel = config.apiUrl && config.apiKey && config.model
+        ? new ai_suggester_1.AISuggester()
+        : new carousel_1.NullSuggester();
+    const app = new app_1.App({ bottomPanel, promptLine0: (0, config_1.buildPromptLine0)(config) });
     await app.run();
 }
 main().catch((err) => {

package/dist/spawner.js

@@ -144,10 +144,19 @@ async function runUserCommand(command) {
         stdio: "inherit",
         windowsVerbatimArguments: true,
     });
-    await new Promise((resolve, reject) => {
-        proc.on("error", reject);
-        proc.on("close", () => resolve());
-    });
+    // While a user command owns the terminal, Ctrl+C should interrupt that command
+    // without taking down the parent Caroushell process.
+    const ignoreSigint = () => { };
+    process.on("SIGINT", ignoreSigint);
+    try {
+        await new Promise((resolve, reject) => {
+            proc.on("error", reject);
+            proc.on("close", () => resolve());
+        });
+    }
+    finally {
+        process.off("SIGINT", ignoreSigint);
+    }
     // Why save failed commands? Well eg sometimes we want to run a test
     // many times until we fix it.
     return true;

package/dist/terminal.js

@@ -22,6 +22,8 @@ class Terminal {
         this.cursorRow = 0;
         this.cursorCol = 0;
         this.writesDisabled = false;
+        this.pendingBlock = null;
+        this.renderScheduled = false;
     }
     disableWrites() {
         this.writesDisabled = true;
@@ -70,6 +72,7 @@ class Terminal {
     write(text) {
         if (!this.canWrite())
             return;
+        this.flushPendingRender();
         this.out.write(text);
     }
     hideCursor() {
@@ -80,6 +83,26 @@ class Terminal {
     }
     // Render a block of lines by clearing previous block (if any) and writing fresh
     renderBlock(lines, cursorRow, cursorCol) {
+        if (!this.canWrite())
+            return;
+        this.pendingBlock = {
+            lines: [...lines],
+            cursorRow,
+            cursorCol,
+        };
+        if (this.renderScheduled)
+            return;
+        this.renderScheduled = true;
+        queueMicrotask(() => this.flushPendingRender());
+    }
+    flushPendingRender() {
+        if (!this.pendingBlock) {
+            this.renderScheduled = false;
+            return;
+        }
+        const pending = this.pendingBlock;
+        this.pendingBlock = null;
+        this.renderScheduled = false;
         if (!this.canWrite())
             return;
         this.withCork(() => {
@@ -88,21 +111,22 @@ class Terminal {
                 readline_1.default.cursorTo(this.out, 0);
                 readline_1.default.clearScreenDown(this.out);
             }
-            for (let i = 0; i < lines.length; i++) {
-                this.write(lines[i]);
-                if (i < lines.length - 1)
-                    this.write("\n");
+            for (let i = 0; i < pending.lines.length; i++) {
+                this.out.write(pending.lines[i]);
+                if (i < pending.lines.length - 1)
+                    this.out.write("\n");
             }
-            this.activeRows = lines.length;
+            this.activeRows = pending.lines.length;
             this.cursorRow = Math.max(0, this.activeRows - 1);
-            const lastLine = lines[this.cursorRow] || "";
+            const lastLine = pending.lines[this.cursorRow] || "";
             this.cursorCol = lastLine.length;
-            const needsPosition = typeof cursorRow === "number" || typeof cursorCol === "number";
+            const needsPosition = typeof pending.cursorRow === "number" ||
+                typeof pending.cursorCol === "number";
             if (needsPosition) {
-                const targetRow = typeof cursorRow === "number"
-                    ? Math.min(Math.max(cursorRow, 0), Math.max(0, this.activeRows - 1))
+                const targetRow = typeof pending.cursorRow === "number"
+                    ? Math.min(Math.max(pending.cursorRow, 0), Math.max(0, this.activeRows - 1))
                     : this.cursorRow;
-                const targetCol = Math.max(0, cursorCol ?? this.cursorCol);
+                const targetCol = Math.max(0, pending.cursorCol ?? this.cursorCol);
                 this.moveCursorTo(targetRow, targetCol);
             }
         });
@@ -125,6 +149,8 @@ class Terminal {
     // When we have printed arbitrary output that is not managed by renderBlock,
     // reset internal line tracking so the next render starts fresh.
     resetBlockTracking() {
+        this.pendingBlock = null;
+        this.renderScheduled = false;
         this.activeRows = 0;
         this.cursorRow = 0;
         this.cursorCol = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "caroushell",
-  "version": "0.1.23",
+  "version": "0.1.29",
   "description": "Terminal carousel that suggests commands from history, config, and AI.",
   "type": "commonjs",
   "main": "dist/main.js",