caroushell 0.1.24 → 0.1.30

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

@@ -26,6 +26,7 @@ class App {
             topRows: 2,
             bottomRows: this.bottomSuggester instanceof carousel_1.NullSuggester ? 0 : 2,
             terminal: this.terminal,
+            promptLine0: deps.promptLine0,
         });
         this.queueUpdateSuggestions = () => {
             void this.carousel.updateSuggestions();

package/dist/carousel.js

@@ -77,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") {
@@ -396,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"));
@@ -113,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,94 +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("");
-    const rl = readline_1.default.createInterface({
-        input: process.stdin,
-        output: process.stdout,
-    });
-    const wantsAi = (await prompt("Do you want to set up AI auto-complete? (y/n): ", rl))
+    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") {
-        rl.close();
-        // Writing noAi or any key will skip the new user flow next run
-        await fs_1.promises.writeFile(configPath, "noAi = true\n", "utf8");
-        console.log("\nSkipping AI setup. You can set it up later by editing " + configPath);
-        console.log("");
+        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;
     }
-    console.log(`\nLet'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");
+    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/main.js

@@ -31,7 +31,7 @@ async function main() {
     const bottomPanel = config.apiUrl && config.apiKey && config.model
         ? new ai_suggester_1.AISuggester()
         : new carousel_1.NullSuggester();
-    const app = new app_1.App({ bottomPanel });
+    const app = new app_1.App({ bottomPanel, promptLine0: (0, config_1.buildPromptLine0)(config) });
     await app.run();
 }
 main().catch((err) => {

package/dist/terminal.js

@@ -73,25 +73,30 @@ class Terminal {
         this.out.write(text);
     }
     hideCursor() {
-        this.write("\x1b[?25l");
+        if (!this.canWrite())
+            return;
+        this.out.write("\x1b[?25l");
     }
     showCursor() {
-        this.write("\x1b[?25h");
+        if (!this.canWrite())
+            return;
+        this.out.write("\x1b[?25h");
     }
     // Render a block of lines by clearing previous block (if any) and writing fresh
     renderBlock(lines, cursorRow, cursorCol) {
         if (!this.canWrite())
             return;
         this.withCork(() => {
+            this.hideCursor();
             this.moveCursorToTopOfBlock();
             if (this.activeRows > 0) {
                 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]);
+                this.out.write(lines[i]);
                 if (i < lines.length - 1)
-                    this.write("\n");
+                    this.out.write("\n");
             }
             this.activeRows = lines.length;
             this.cursorRow = Math.max(0, this.activeRows - 1);
@@ -105,6 +110,7 @@ class Terminal {
                 const targetCol = Math.max(0, cursorCol ?? this.cursorCol);
                 this.moveCursorTo(targetRow, targetCol);
             }
+            this.showCursor();
         });
     }
     moveCursorTo(lineIndex, column) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "caroushell",
-  "version": "0.1.24",
+  "version": "0.1.30",
   "description": "Terminal carousel that suggests commands from history, config, and AI.",
   "type": "commonjs",
   "main": "dist/main.js",
@@ -18,7 +18,7 @@
     "prepare": "npm run build",
     "start": "node dist/main.js",
     "test": "node --import tsx --test tests/*.ts",
-    "test:generate": "tsx src/test-generate.ts",
+    "test:ai-generate": "tsx src/test-generate.ts",
     "lint": "eslint . --ext .ts",
     "release": "tsx scripts/release.ts"
   },