croo-cli 0.1.1 → 0.1.2

package/README.md

@@ -1,20 +1,52 @@
+<div align="center">
+
+```
+ ▄▄▄   ▄▄▄
+██▄█▄▄▄█▄██
+▀█▄▀▀▀▀▀▄█▀
+ ▀▀     ▀▀
+```
+
 # Croo
 
-A quick, minimal, open-source terminal AI coding agent. Bring your own API key (or a local model) and let a small frog help you code.
+**A tiny terminal coding agent with a frog in it.**
+Bring your own API key, or a local model. No accounts, no telemetry, no backend.
+
+[![npm](https://img.shields.io/npm/v/croo-cli?color=5ed67e&label=npm)](https://www.npmjs.com/package/croo-cli)
+[![CI](https://github.com/xandertaylorx/croo/actions/workflows/ci.yml/badge.svg)](https://github.com/xandertaylorx/croo/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-5ed67e)](LICENSE)
+[![Node](https://img.shields.io/badge/node-%E2%89%A520-5ed67e)](https://nodejs.org)
+[![Dependencies](https://img.shields.io/badge/runtime%20deps-0-5ed67e)](package.json)
+
+</div>
 
 ```
  ▄▄▄   ▄▄▄    “ribbit. ready when you are.”
-██▄█▄▄▄█▄██   Croo v0.1.0
+██▄█▄▄▄█▄██   Croo v0.1.1
 ▀█▄▀▀▀▀▀▄█▀   gpt-4o · openai
  ▀▀     ▀▀    ~/projects/my-app
               /help for commands
+
+  gpt-4o · ~/projects/my-app
+› add a --verbose flag to the CLI
+
+  ◇ read_file src/cli.ts ✓
+  ✎ edit_file src/cli.ts
+╭─ edit_file src/cli.ts ─────────────────────────
+│ 12   const args = parseArgs(process.argv)
+│ 13 + const verbose = args.verbose
+╰ Allow? [y]es / [n]o / [a]lways
 ```
 
-- **Fully local.** No accounts, no login, no telemetry, no backend. Config lives in `~/.config/croo/config.json`.
-- **Provider-agnostic.** OpenAI-compatible endpoints, Anthropic, and Google Gemini.
-- **Tiny.** Zero runtime dependencies: native `fetch` and Node built-ins only.
+## Why Croo
 
-Croo works with API keys and any OpenAI-compatible endpoint, including local models. It does not use anyone's consumer-subscription logins.
+- **Fully local.** Your config and history stay on your machine, in `~/.config/croo` and `~/.local/share/croo`.
+- **Bring your own model.** OpenAI, Anthropic, Google Gemini, or anything OpenAI-compatible: OpenRouter, Groq, Together, DeepSeek, Mistral, Ollama, LM Studio, llama.cpp, vLLM.
+- **Small and readable.** TypeScript, zero runtime dependencies, native `fetch`. You can read the whole thing in an afternoon.
+- **You stay in control.** Every file write and shell command shows a diff or the exact command and waits for your OK.
+- **A little charm.** A pixel frog lives in your terminal. It blinks, hops while tools run, and reacts when things go well or badly. `--no-pet` sends it home.
+
+> Croo works with API keys and any OpenAI-compatible endpoint, including local models. It does not use anyone's consumer-subscription logins.
 
 ## Install
 
@@ -22,27 +54,41 @@ Croo works with API keys and any OpenAI-compatible endpoint, including local mod
 npm i -g croo-cli
 ```
 
-Requires Node 20+.
+Needs Node 20 or newer. The command is `croo`.
+
+## Try it without an API key
+
+```bash
+croo --demo
+```
+
+A scripted fake model walks you through the interface: streaming markdown, tool cards, the spinner, and a diff permission prompt. Nothing leaves your machine and nothing is saved.
 
 ## Quick start
 
 ```bash
 cd your-project
-croo                      # first run walks you through setup
-croo "add a --verbose flag to the CLI"   # one-shot
-croo --continue           # resume the last session in this directory
-croo --profile local      # use a named profile
-croo --yolo               # skip permission prompts (be careful)
-croo --no-pet             # no frog
-croo --demo               # look around with a fake model, no API key
+croo                       # first run walks you through setup
+croo "fix the failing test"   # one-shot: run a task and exit
+croo --continue            # resume the last session in this directory
+croo --profile local       # use a named profile
 ```
 
-Slash commands: `/help`, `/model` (list, `/model <name>` to switch, `/model add`), `/clear`, `/config`, `/exit`.
-`Ctrl+C` cancels the current generation; a second `Ctrl+C` exits.
+| Flag | What it does |
+| --- | --- |
+| `-p, --profile <name>` | Use a named profile from the config |
+| `-c, --continue` | Resume the last session in this directory |
+| `--yolo` | Skip permission prompts (be careful) |
+| `--no-pet` | Hide the frog |
+| `--demo` | Try the interface with a fake model |
+| `-v, --version` / `-h, --help` | Version / help |
+
+**In the session:** `/help` · `/model` (list; `/model <name>` switches; `/model add`) · `/clear` · `/config` · `/exit`.
+`Ctrl+C` cancels the current generation. A second `Ctrl+C` exits.
 
-## Configuration
+## Configure providers
 
-`~/.config/croo/config.json` (created with mode 600). API keys may live here or in env vars: `CROO_API_KEY`, `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, `GEMINI_API_KEY`. Priority is the profile's `apiKey`, then `CROO_API_KEY`, then the provider's own variable.
+Config lives at `~/.config/croo/config.json` and is created with mode `600`. Add as many named profiles as you like and switch with `/model` or `--profile`.
 
 ```jsonc
 {
@@ -50,9 +96,9 @@ Slash commands: `/help`, `/model` (list, `/model <name>` to switch, `/model add`
   "pet": true,
   "animations": true,
   "profiles": {
-    "openai": { "type": "openai", "model": "gpt-4o" },
+    "openai":    { "type": "openai",    "model": "gpt-4o" },
     "anthropic": { "type": "anthropic", "model": "claude-sonnet-4-5" },
-    "gemini": { "type": "gemini", "model": "gemini-2.5-pro" },
+    "gemini":    { "type": "gemini",    "model": "gemini-2.5-pro" },
     "openrouter": {
       "type": "openai",
       "baseUrl": "https://openrouter.ai/api/v1",
@@ -67,6 +113,8 @@ Slash commands: `/help`, `/model` (list, `/model <name>` to switch, `/model add`
 }
 ```
 
+**API keys** can go in the profile (`"apiKey": "..."`) or in the environment. Lookup order: the profile's `apiKey`, then `CROO_API_KEY`, then the provider's own variable (`OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, `GEMINI_API_KEY`). Local servers like Ollama need no key.
+
 Optional per-profile `inputPerMTok` / `outputPerMTok` (USD per million tokens) adds a cost estimate to the status line.
 
 ## Tools and permissions
@@ -74,36 +122,48 @@ Optional per-profile `inputPerMTok` / `outputPerMTok` (USD per million tokens) a
 | Tool | What it does | Asks first? |
 | --- | --- | --- |
 | `read_file` | Read a file with line numbers | no |
-| `list_files` | List/glob files (respects `.gitignore`) | no |
+| `list_files` | List or glob files (respects `.gitignore`) | no |
 | `grep` | Regex search (respects `.gitignore`) | no |
 | `write_file` | Create or overwrite a file | yes, shows a diff |
 | `edit_file` | Exact string replace | yes, shows a diff |
-| `bash` | Run a shell command (120s timeout, truncated output) | yes, shows the command |
+| `bash` | Run a shell command (120s timeout, output truncated) | yes, shows the command |
+
+Answer `y`, `n`, or `a` (always allow that tool for this session). File tools can never leave the current directory, symlinks included.
+
+**Project instructions:** drop a `CROO.md` or `AGENTS.md` in your project and Croo adds it to its system prompt.
 
-Prompts accept `y`, `n` or `a` (always, for that tool, this session). File tools cannot leave the current directory. Put project guidance in `CROO.md` or `AGENTS.md` and Croo will include it in its system prompt.
+**Sessions** are saved as plain JSON in `~/.local/share/croo/sessions`.
 
-Sessions are saved as JSON under `~/.local/share/croo/sessions`.
+## Look and feel
+
+Colours come from one file, `src/ui/theme.ts`. Croo uses 24-bit colour when your terminal supports it and falls back to 256 or 16. It respects `NO_COLOR`, and turns off colour and animation when output is piped, so `croo "..." > out.txt` stays clean. Set `"animations": false` or `"pet": false` in the config to calm things down.
 
 ## Development
 
 ```bash
-npm install && npm test && npm run build
+git clone https://github.com/xandertaylorx/croo && cd croo
+npm install
+npm test            # vitest
+npm run build       # dist/cli.js
+node dist/cli.js --demo
 ```
 
-See [CONTRIBUTING.md](CONTRIBUTING.md).
+See [CONTRIBUTING.md](CONTRIBUTING.md). Issues and pull requests are welcome.
 
 ## Roadmap
 
-- Custom pets: the `Pet` interface in `src/ui/pet.ts` is designed so you can drop in your own frames
-- Idle animation at the prompt
-- Context window management and compaction
-- MCP support
-- More tools (web fetch, multi-edit)
+- [ ] Custom pets: the `Pet` interface in `src/ui/pet.ts` is built so you can drop in your own frames
+- [ ] Idle animation at the prompt
+- [ ] Context-window management and compaction
+- [ ] MCP support
+- [ ] More tools: web fetch, multi-edit
 
 ## License
 
-MIT, see [LICENSE](LICENSE).
+[MIT](LICENSE), Copyright (c) 2026 Xander Taylor. Free to use, change and share.
+
+<div align="center">
 
----
+<sub>An Entity of The Tizzle Collective</sub>
 
-An Entity of The Tizzle Collective
+</div>

package/dist/cli.js

@@ -6,7 +6,7 @@ import readline from "readline";
 // package.json
 var package_default = {
   name: "croo-cli",
-  version: "0.1.1",
+  version: "0.1.2",
   description: "Croo: a quick, minimal, open-source terminal AI coding agent. Bring your own API key.",
   type: "module",
   bin: {
@@ -937,6 +937,20 @@ function createProvider(profile, env = process.env) {
   return openaiProvider(profile, key);
 }
 
+// src/providers/presets.ts
+var PRESETS = [
+  { id: "openai", label: "OpenAI", type: "openai", model: "gpt-4o" },
+  { id: "anthropic", label: "Anthropic (Claude)", type: "anthropic", model: "claude-sonnet-4-5" },
+  { id: "gemini", label: "Google Gemini", type: "gemini", model: "gemini-2.5-pro" },
+  { id: "groq", label: "Groq", type: "openai", baseUrl: "https://api.groq.com/openai/v1", model: "llama-3.3-70b-versatile" },
+  { id: "openrouter", label: "OpenRouter", type: "openai", baseUrl: "https://openrouter.ai/api/v1", model: "anthropic/claude-sonnet-4.5" },
+  { id: "deepseek", label: "DeepSeek", type: "openai", baseUrl: "https://api.deepseek.com/v1", model: "deepseek-chat" },
+  { id: "xai", label: "xAI (Grok)", type: "openai", baseUrl: "https://api.x.ai/v1", model: "grok-4" },
+  { id: "mistral", label: "Mistral", type: "openai", baseUrl: "https://api.mistral.ai/v1", model: "mistral-large-latest" },
+  { id: "together", label: "Together AI", type: "openai", baseUrl: "https://api.together.xyz/v1", model: "meta-llama/Llama-3.3-70B-Instruct-Turbo" },
+  { id: "ollama", label: "Ollama (local, no key)", type: "openai", baseUrl: "http://localhost:11434/v1", model: "llama3.2", noKey: true }
+];
+
 // src/session.ts
 import fs5 from "fs";
 import path5 from "path";
@@ -1530,27 +1544,63 @@ var ask = (question, opts) => {
     muted = !!opts?.secret;
   });
 };
-var DEFAULT_MODELS = { openai: "gpt-4o", anthropic: "claude-sonnet-4-5", gemini: "gemini-2.5-pro" };
-async function setupProfile(a, cfg) {
-  console.log(theme.bold("\nSet up a provider") + theme.muted("  (stored in " + configPath() + ", mode 600)\n"));
-  console.log("  1) OpenAI-compatible  (OpenAI, OpenRouter, Groq, Ollama, LM Studio, ...)\n  2) Anthropic\n  3) Google Gemini\n");
-  const choice = (await a("Provider [1]: ")).trim() || "1";
-  const type = choice === "2" ? "anthropic" : choice === "3" ? "gemini" : "openai";
-  const profile = { type, model: "" };
-  if (type === "openai") {
-    const url = (await a(`Base URL [${DEFAULT_BASE_URLS.openai}] (Ollama: http://localhost:11434/v1): `)).trim();
-    if (url) profile.baseUrl = url;
-  }
-  const key = (await a("API key (leave blank to use an env var, or for local models): ", { secret: true })).trim();
-  if (key) profile.apiKey = key;
-  profile.model = (await a(`Model [${DEFAULT_MODELS[type]}]: `)).trim() || DEFAULT_MODELS[type];
-  let base = type === "openai" && profile.baseUrl ? new URL(profile.baseUrl).hostname.replace(/^api\./, "").split(".")[0] : type;
+async function askKey(a, label) {
+  for (; ; ) {
+    const key = (await a(`Paste your ${label} API key: `, { secret: true })).trim();
+    if (key) return key;
+    if (!process.stdin.isTTY) return "";
+    console.log(theme.muted("  (nothing pasted, try again)"));
+  }
+}
+async function setupProfile(a, cfg, opts = {}) {
+  console.log(theme.bold("\nPick a provider\n"));
+  PRESETS.forEach((p, i) => console.log(`  ${String(i + 1).padStart(2)}) ${p.label}`));
+  const otherN = PRESETS.length + 1;
+  console.log(`  ${String(otherN).padStart(2)}) Other (any OpenAI-compatible URL)`);
+  if (opts.allowDemo) console.log(`  ${String(otherN + 1).padStart(2)}) Demo mode (no key)`);
+  console.log();
+  let preset;
+  let custom = false;
+  for (; ; ) {
+    const raw = (await a("Number: ")).trim().toLowerCase();
+    if (!raw && !process.stdin.isTTY) return null;
+    const n = Number(raw);
+    preset = Number.isInteger(n) ? PRESETS[n - 1] : PRESETS.find((p) => p.id === raw);
+    if (preset) break;
+    if (n === otherN) {
+      custom = true;
+      break;
+    }
+    if (opts.allowDemo && (n === otherN + 1 || raw.startsWith("d"))) return null;
+    console.log(theme.muted("  Pick a number from the list."));
+  }
+  let profile;
+  let base;
+  if (custom) {
+    let url = "";
+    while (!url) {
+      url = (await a("Base URL (e.g. https://api.example.com/v1): ")).trim();
+      try {
+        new URL(url);
+      } catch {
+        url = "";
+      }
+    }
+    profile = { type: "openai", baseUrl: url, model: (await a("Model name: ")).trim() || "gpt-4o" };
+    if (!isLocalUrl(url)) profile.apiKey = await askKey(a, new URL(url).hostname);
+    base = new URL(url).hostname.replace(/^api\./, "").split(".")[0];
+  } else {
+    profile = { type: preset.type, model: preset.model };
+    if (preset.baseUrl) profile.baseUrl = preset.baseUrl;
+    if (!preset.noKey) profile.apiKey = await askKey(a, preset.label);
+    base = preset.id;
+  }
   let name = base;
   for (let i = 2; cfg.profiles[name]; i++) name = `${base}${i}`;
   const next = { ...cfg, profiles: { ...cfg.profiles, [name]: profile }, activeProfile: name };
   saveConfig(next);
   console.log(theme.accent(`
-Saved profile "${name}".
+Saved. Using ${profile.model}. Change it any time with /model.
 `));
   return next;
 }
@@ -1565,13 +1615,6 @@ async function main() {
   if (args.help) return console.log(HELP);
   if (args.version) return console.log(VERSION);
   let cfg = args.demo ? null : loadConfig();
-  if (!args.demo && (!cfg || !Object.keys(cfg.profiles).length)) {
-    if (process.stdin.isTTY) {
-      console.log(theme.accent(theme.bold("Welcome to Croo.")) + " No config yet.");
-      const choice = await ask("Set up a provider now, or look around in demo mode (no API key)? [setup/demo]: ");
-      if (choice.trim().toLowerCase().startsWith("d")) args.demo = true;
-    }
-  }
   if (args.demo) {
     cfg = { ...defaultConfig(), activeProfile: "demo", profiles: { demo: DEMO_PROFILE } };
   } else if (!cfg || !Object.keys(cfg.profiles).length) {
@@ -1579,13 +1622,29 @@ async function main() {
       console.error(`No config found. Run \`croo\` in a terminal to set one up, or create ${configPath()}.`);
       process.exit(1);
     }
-    cfg = await setupProfile(ask, cfg ?? defaultConfig());
+    console.log(theme.accent(theme.bold("Welcome to Croo.")));
+    const made = await setupProfile(ask, cfg ?? defaultConfig(), { allowDemo: true });
+    if (made) cfg = made;
+    else {
+      args.demo = true;
+      cfg = { ...defaultConfig(), activeProfile: "demo", profiles: { demo: DEMO_PROFILE } };
+    }
   }
   let profileName = args.profile ?? cfg.activeProfile;
   if (!cfg.profiles[profileName]) {
     console.error(`Unknown profile "${profileName}". Available: ${Object.keys(cfg.profiles).join(", ")}`);
     process.exit(1);
   }
+  const needsKey = (p) => !args.demo && !resolveApiKey(p) && !(p.type === "openai" && isLocalUrl(p.baseUrl));
+  if (needsKey(cfg.profiles[profileName]) && process.stdin.isTTY) {
+    const p = cfg.profiles[profileName];
+    console.log(theme.muted(`No API key for "${profileName}" yet.`));
+    const key = await askKey(ask, profileName);
+    if (key) {
+      p.apiKey = key;
+      saveConfig(cfg);
+    }
+  }
   const ui = new Ui({ theme, pet: frogPet, showPet: cfg.pet && !args.noPet, animations: cfg.animations, ask });
   const permissions = new Permissions(args.yolo);
   const persist = !args.demo;
@@ -1716,7 +1775,7 @@ async function main() {
     },
     model: async (arg) => {
       if (arg === "add") {
-        cfg = await setupProfile(ask, cfg);
+        cfg = await setupProfile(ask, cfg) ?? cfg;
         arg = cfg.activeProfile;
       }
       if (!arg) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "croo-cli",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Croo: a quick, minimal, open-source terminal AI coding agent. Bring your own API key.",
   "type": "module",
   "bin": {