@bilalimamoglu/sift 0.2.1 → 0.2.2

package/README.md

@@ -1,5 +1,7 @@
 # sift
 
+<img src="assets/brand/sift-logo-badge-monochrome.svg" alt="sift logo" width="88" />
+
 `sift` is a small command-output reducer for agent workflows.
 
 Instead of feeding a model the full output of `pytest`, `git diff`, `npm audit`, `tsc --noEmit`, `eslint .`, or `terraform plan`, you run the command through `sift`. It captures the output, trims the noise, and returns a much smaller answer.
@@ -24,7 +26,21 @@ npm install -g @bilalimamoglu/sift
 
 ## One-time setup
 
-For OpenAI-hosted models:
+The easiest path is the guided setup:
+
+```bash
+sift config setup
+```
+
+That writes a machine-wide config to:
+
+```text
+~/.config/sift/config.yaml
+```
+
+After that, any terminal can use `sift` without per-project setup. A repo-local config can still override it later.
+
+If you want to set things up manually, for OpenAI-hosted models:
 
 ```bash
 export SIFT_PROVIDER=openai
@@ -33,12 +49,30 @@ export SIFT_MODEL=gpt-5-nano
 export OPENAI_API_KEY=your_openai_api_key
 ```
 
-Or generate a config file:
+Or write a template config file:
 
 ```bash
 sift config init
 ```
 
+For a manual machine-wide template:
+
+```bash
+sift config init --global
+```
+
+That writes:
+
+```text
+~/.config/sift/config.yaml
+```
+
+Then keep the API key in your shell profile so every terminal can use it:
+
+```bash
+export OPENAI_API_KEY=your_openai_api_key
+```
+
 If you use a different OpenAI-compatible endpoint, switch to `provider: openai-compatible` and use either the endpoint's native API key env var or the generic fallback:
 
 ```bash
@@ -124,6 +158,7 @@ Built-in JSON and verdict flows return strict error objects on provider or model
 Useful commands:
 
 ```bash
+sift config setup
 sift config init
 sift config show
 sift config validate
@@ -195,6 +230,15 @@ The workflow:
 5. creates and pushes the `vX.Y.Z` tag
 6. creates a GitHub Release
 
+## Brand assets
+
+Curated public logo assets live in `assets/brand/`.
+
+Included SVG sets:
+- badge/app: teal, black, monochrome
+- icon-only: teal, black, monochrome
+- 24px icon: teal, black, monochrome
+
 ## License
 
 MIT

package/dist/cli.js

@@ -13,12 +13,17 @@ import YAML from "yaml";
 import os from "os";
 import path from "path";
 var DEFAULT_CONFIG_FILENAME = "sift.config.yaml";
-var DEFAULT_CONFIG_SEARCH_PATHS = [
-  path.resolve(process.cwd(), "sift.config.yaml"),
-  path.resolve(process.cwd(), "sift.config.yml"),
-  path.join(os.homedir(), ".config", "sift", "config.yaml"),
-  path.join(os.homedir(), ".config", "sift", "config.yml")
-];
+function getDefaultGlobalConfigPath() {
+  return path.join(os.homedir(), ".config", "sift", "config.yaml");
+}
+function getDefaultConfigSearchPaths() {
+  return [
+    path.resolve(process.cwd(), "sift.config.yaml"),
+    path.resolve(process.cwd(), "sift.config.yml"),
+    getDefaultGlobalConfigPath(),
+    path.join(os.homedir(), ".config", "sift", "config.yml")
+  ];
+}
 var INSUFFICIENT_SIGNAL_TEXT = "Insufficient signal in the provided input.";
 var GENERIC_JSON_CONTRACT = '{"answer":string,"evidence":string[],"risks":string[]}';
 var CAPTURE_OMITTED_MARKER = "\n...[captured output omitted]...\n";
@@ -32,7 +37,7 @@ function findConfigPath(explicitPath) {
     }
     return resolved;
   }
-  for (const candidate of DEFAULT_CONFIG_SEARCH_PATHS) {
+  for (const candidate of getDefaultConfigSearchPaths()) {
     if (fs.existsSync(candidate)) {
       return candidate;
     }
@@ -339,8 +344,11 @@ function resolveConfig(options = {}) {
 import fs2 from "fs";
 import path3 from "path";
 import YAML2 from "yaml";
-function writeExampleConfig(targetPath) {
-  const resolved = path3.resolve(targetPath ?? DEFAULT_CONFIG_FILENAME);
+function writeExampleConfig(options = {}) {
+  if (options.global && options.targetPath) {
+    throw new Error("Use either --path <path> or --global, not both.");
+  }
+  const resolved = options.global ? getDefaultGlobalConfigPath() : path3.resolve(options.targetPath ?? DEFAULT_CONFIG_FILENAME);
   if (fs2.existsSync(resolved)) {
     throw new Error(`Config file already exists at ${resolved}`);
   }
@@ -349,6 +357,226 @@ function writeExampleConfig(targetPath) {
   fs2.writeFileSync(resolved, yaml, "utf8");
   return resolved;
 }
+function writeConfigFile(options) {
+  const resolved = path3.resolve(options.targetPath);
+  if (!options.overwrite && fs2.existsSync(resolved)) {
+    throw new Error(`Config file already exists at ${resolved}`);
+  }
+  const yaml = YAML2.stringify(options.config);
+  fs2.mkdirSync(path3.dirname(resolved), { recursive: true });
+  fs2.writeFileSync(resolved, yaml, {
+    encoding: "utf8",
+    mode: 384
+  });
+  try {
+    fs2.chmodSync(resolved, 384);
+  } catch {
+  }
+  return resolved;
+}
+
+// src/commands/config-setup.ts
+import fs3 from "fs";
+import path4 from "path";
+import { createInterface } from "readline/promises";
+import { clearLine, cursorTo, emitKeypressEvents, moveCursor } from "readline";
+import { stdin as defaultStdin, stdout as defaultStdout, stderr as defaultStderr } from "process";
+function createTerminalIO() {
+  let rl;
+  function getInterface() {
+    if (!rl) {
+      rl = createInterface({
+        input: defaultStdin,
+        output: defaultStdout,
+        terminal: true
+      });
+    }
+    return rl;
+  }
+  async function select(prompt, options) {
+    const input = defaultStdin;
+    const output = defaultStdout;
+    const promptLine = `${prompt} (use \u2191/\u2193 and Enter)`;
+    let index = 0;
+    const lineCount = options.length + 1;
+    emitKeypressEvents(input);
+    input.resume();
+    const wasRaw = input.isTTY ? input.isRaw : false;
+    input.setRawMode?.(true);
+    const render = () => {
+      cursorTo(output, 0);
+      clearLine(output, 0);
+      output.write(`${promptLine}
+`);
+      for (let optionIndex = 0; optionIndex < options.length; optionIndex += 1) {
+        clearLine(output, 0);
+        output.write(`${optionIndex === index ? "\u203A" : " "} ${options[optionIndex]}
+`);
+      }
+      moveCursor(output, 0, -lineCount);
+    };
+    render();
+    return await new Promise((resolve, reject) => {
+      const onKeypress = (_value, key) => {
+        if (key.ctrl && key.name === "c") {
+          cleanup();
+          reject(new Error("Aborted."));
+          return;
+        }
+        if (key.name === "up") {
+          index = index === 0 ? options.length - 1 : index - 1;
+          render();
+          return;
+        }
+        if (key.name === "down") {
+          index = (index + 1) % options.length;
+          render();
+          return;
+        }
+        if (key.name === "return" || key.name === "enter") {
+          const selected = options[index] ?? options[0];
+          cleanup();
+          resolve(selected ?? "OpenAI");
+        }
+      };
+      const cleanup = () => {
+        input.off("keypress", onKeypress);
+        moveCursor(output, 0, lineCount);
+        cursorTo(output, 0);
+        clearLine(output, 0);
+        output.write("\n");
+        input.setRawMode?.(Boolean(wasRaw));
+      };
+      input.on("keypress", onKeypress);
+    });
+  }
+  return {
+    stdinIsTTY: Boolean(defaultStdin.isTTY),
+    stdoutIsTTY: Boolean(defaultStdout.isTTY),
+    ask(prompt) {
+      return getInterface().question(prompt);
+    },
+    select,
+    write(message) {
+      defaultStdout.write(message);
+    },
+    error(message) {
+      defaultStderr.write(message);
+    },
+    close() {
+      rl?.close();
+    }
+  };
+}
+function resolveSetupPath(targetPath) {
+  return targetPath ? path4.resolve(targetPath) : getDefaultGlobalConfigPath();
+}
+function buildOpenAISetupConfig(apiKey) {
+  return {
+    ...defaultConfig,
+    provider: {
+      ...defaultConfig.provider,
+      provider: "openai",
+      model: "gpt-5-nano",
+      baseUrl: "https://api.openai.com/v1",
+      apiKey
+    }
+  };
+}
+async function promptForProvider(io) {
+  if (io.select) {
+    const choice = await io.select("Select provider", ["OpenAI"]);
+    if (choice === "OpenAI") {
+      return "openai";
+    }
+  }
+  while (true) {
+    const answer = (await io.ask("Provider [OpenAI]: ")).trim().toLowerCase();
+    if (answer === "" || answer === "openai") {
+      return "openai";
+    }
+    io.error("Only OpenAI is supported in guided setup right now.\n");
+  }
+}
+async function promptForApiKey(io) {
+  while (true) {
+    const answer = (await io.ask("Enter your OpenAI API key: ")).trim();
+    if (answer.length > 0) {
+      return answer;
+    }
+    io.error("API key cannot be empty.\n");
+  }
+}
+async function promptForOverwrite(io, targetPath) {
+  while (true) {
+    const answer = (await io.ask(
+      `Config file already exists at ${targetPath}. Overwrite? [y/N]: `
+    )).trim().toLowerCase();
+    if (answer === "" || answer === "n" || answer === "no") {
+      return false;
+    }
+    if (answer === "y" || answer === "yes") {
+      return true;
+    }
+    io.error("Please answer y or n.\n");
+  }
+}
+async function configSetup(options = {}) {
+  void options.global;
+  const io = options.io ?? createTerminalIO();
+  try {
+    if (!io.stdinIsTTY || !io.stdoutIsTTY) {
+      io.error(
+        "sift config setup is interactive and requires a TTY. Use 'sift config init --global' for a non-interactive template.\n"
+      );
+      return 1;
+    }
+    const resolvedPath = resolveSetupPath(options.targetPath);
+    if (fs3.existsSync(resolvedPath)) {
+      const shouldOverwrite = await promptForOverwrite(io, resolvedPath);
+      if (!shouldOverwrite) {
+        io.write("Aborted.\n");
+        return 1;
+      }
+    }
+    const provider = await promptForProvider(io);
+    if (provider !== "openai") {
+      io.error("Unsupported provider selection.\n");
+      return 1;
+    }
+    io.write("Using OpenAI defaults.\n");
+    io.write("Default model: gpt-5-nano\n");
+    io.write("Default base URL: https://api.openai.com/v1\n");
+    io.write(
+      "You can change these later by editing the config file or running 'sift config show --show-secrets'.\n"
+    );
+    const apiKey = await promptForApiKey(io);
+    const config = buildOpenAISetupConfig(apiKey);
+    const writtenPath = writeConfigFile({
+      targetPath: resolvedPath,
+      config,
+      overwrite: true
+    });
+    io.write(`Wrote ${writtenPath}
+`);
+    io.write(
+      "This is your machine-wide default config. Repo-local sift.config.yaml can still override it later.\n"
+    );
+    const activeConfigPath = findConfigPath();
+    if (activeConfigPath && path4.resolve(activeConfigPath) !== path4.resolve(writtenPath)) {
+      io.write(
+        `Note: ${activeConfigPath} currently overrides this machine-wide config in the current directory.
+`
+      );
+    }
+    io.write("Try:\n");
+    io.write("  sift doctor\n");
+    io.write("  sift exec --preset test-status -- pytest\n");
+    return 0;
+  } finally {
+    io.close?.();
+  }
+}
 
 // src/commands/config.ts
 var MASKED_SECRET = "***";
@@ -369,9 +597,12 @@ function maskConfigSecrets(value) {
   }
   return output;
 }
-function configInit(targetPath) {
-  const path4 = writeExampleConfig(targetPath);
-  process.stdout.write(`${path4}
+function configInit(targetPath, global = false) {
+  const path5 = writeExampleConfig({
+    targetPath,
+    global
+  });
+  process.stdout.write(`${path5}
 `);
 }
 function configShow(configPath, showSecrets = false) {
@@ -396,10 +627,11 @@ function configValidate(configPath) {
 }
 
 // src/commands/doctor.ts
-function runDoctor(config) {
+function runDoctor(config, configPath) {
   const lines = [
     "sift doctor",
     "mode: local config completeness check",
+    `configPath: ${configPath ?? "(defaults only)"}`,
     `provider: ${config.provider.provider}`,
     `model: ${config.provider.model}`,
     `baseUrl: ${config.provider.baseUrl}`,
@@ -1429,6 +1661,15 @@ function buildCommandPreview(request) {
   }
   return (request.command ?? []).join(" ");
 }
+function getExecSuccessShortcut(args) {
+  if (args.exitCode !== 0) {
+    return null;
+  }
+  if (args.presetName === "typecheck-summary" && args.capturedOutput.trim() === "") {
+    return "No type errors.";
+  }
+  return null;
+}
 async function runExec(request) {
   const hasArgvCommand = Array.isArray(request.command) && request.command.length > 0;
   const hasShellCommand = typeof request.shellCommand === "string";
@@ -1493,6 +1734,7 @@ async function runExec(request) {
     throw childSpawnError;
   }
   const exitCode = normalizeChildExitCode(childStatus, childSignal);
+  const capturedOutput = capture.render();
   if (request.config.runtime.verbose) {
     process.stderr.write(
       `${pc2.dim("sift")} child_exit=${exitCode} captured_chars=${capture.getTotalChars()} capture_truncated=${capture.wasTruncated()}
@@ -1500,9 +1742,25 @@ async function runExec(request) {
     );
   }
   if (!bypassed) {
+    const execSuccessShortcut = getExecSuccessShortcut({
+      presetName: request.presetName,
+      exitCode,
+      capturedOutput
+    });
+    if (execSuccessShortcut && !request.dryRun) {
+      if (request.config.runtime.verbose) {
+        process.stderr.write(
+          `${pc2.dim("sift")} exec_shortcut=${request.presetName}
+`
+        );
+      }
+      process.stdout.write(`${execSuccessShortcut}
+`);
+      return exitCode;
+    }
     const output = await runSift({
       ...request,
-      stdin: capture.render()
+      stdin: capturedOutput
     });
     process.stdout.write(`${output}
 `);
@@ -1541,6 +1799,12 @@ function getPreset(config, name) {
 var require2 = createRequire(import.meta.url);
 var pkg = require2("../package.json");
 var cli = cac("sift");
+var HELP_BANNER = [
+  "   \\\\  //",
+  "    \\\\//",
+  "     ||",
+  "     o"
+].join("\n");
 function toNumber(value) {
   if (value === void 0 || value === null || value === "") {
     return void 0;
@@ -1726,10 +1990,23 @@ applySharedOptions(
 });
 cli.command(
   "config <action>",
-  "Config commands: init | show | validate (show/validate use resolved runtime config)"
-).usage("config <init|show|validate> [options]").example("config init").example("config show").example("config validate --config ./sift.config.yaml").option("--path <path>", "Target config path for init").option("--config <path>", "Path to config file").option("--show-secrets", "Show secret values in config show").action((action, options) => {
+  "Config commands: setup | init | show | validate (show/validate use resolved runtime config)"
+).usage("config <setup|init|show|validate> [options]").example("config setup").example("config setup --global").example("config setup --path ~/.config/sift/config.yaml").example("config init").example("config init --global").example("config show").example("config validate --config ./sift.config.yaml").option("--path <path>", "Target config path for init or setup").option(
+  "--global",
+  "Use the machine-wide config path (~/.config/sift/config.yaml) for init or setup"
+).option("--config <path>", "Path to config file").option("--show-secrets", "Show secret values in config show").action(async (action, options) => {
+  if (action === "setup") {
+    process.exitCode = await configSetup({
+      targetPath: options.path,
+      global: Boolean(options.global)
+    });
+    return;
+  }
   if (action === "init") {
-    configInit(options.path);
+    configInit(
+      options.path,
+      Boolean(options.global)
+    );
     return;
   }
   if (action === "show") {
@@ -1746,11 +2023,12 @@ cli.command(
   throw new Error(`Unknown config action: ${action}`);
 });
 cli.command("doctor", "Check local runtime config completeness").usage("doctor [options]").option("--config <path>", "Path to config file").action((options) => {
+  const configPath = findConfigPath(options.config);
   const config = resolveConfig({
     configPath: options.config,
     env: process.env
   });
-  process.exitCode = runDoctor(config);
+  process.exitCode = runDoctor(config, configPath);
 });
 cli.command("presets <action> [name]", "Preset commands: list | show").usage("presets <list|show> [name] [options]").example("presets list").example("presets show infra-risk").option("--config <path>", "Path to config file").option("--internal", "Show internal preset fields in presets show").action((action, name, options) => {
   const config = resolveConfig({
@@ -1783,7 +2061,13 @@ applySharedOptions(
     options
   });
 });
-cli.help();
+cli.help((sections) => [
+  {
+    body: `${HELP_BANNER}
+`
+  },
+  ...sections
+]);
 cli.version(pkg.version);
 async function main() {
   cli.parse(process.argv, { run: false });

package/dist/index.js

@@ -6,12 +6,17 @@ import pc2 from "picocolors";
 // src/constants.ts
 import os from "os";
 import path from "path";
-var DEFAULT_CONFIG_SEARCH_PATHS = [
-  path.resolve(process.cwd(), "sift.config.yaml"),
-  path.resolve(process.cwd(), "sift.config.yml"),
-  path.join(os.homedir(), ".config", "sift", "config.yaml"),
-  path.join(os.homedir(), ".config", "sift", "config.yml")
-];
+function getDefaultGlobalConfigPath() {
+  return path.join(os.homedir(), ".config", "sift", "config.yaml");
+}
+function getDefaultConfigSearchPaths() {
+  return [
+    path.resolve(process.cwd(), "sift.config.yaml"),
+    path.resolve(process.cwd(), "sift.config.yml"),
+    getDefaultGlobalConfigPath(),
+    path.join(os.homedir(), ".config", "sift", "config.yml")
+  ];
+}
 var INSUFFICIENT_SIGNAL_TEXT = "Insufficient signal in the provided input.";
 var GENERIC_JSON_CONTRACT = '{"answer":string,"evidence":string[],"risks":string[]}';
 var CAPTURE_OMITTED_MARKER = "\n...[captured output omitted]...\n";
@@ -971,6 +976,15 @@ function buildCommandPreview(request) {
   }
   return (request.command ?? []).join(" ");
 }
+function getExecSuccessShortcut(args) {
+  if (args.exitCode !== 0) {
+    return null;
+  }
+  if (args.presetName === "typecheck-summary" && args.capturedOutput.trim() === "") {
+    return "No type errors.";
+  }
+  return null;
+}
 async function runExec(request) {
   const hasArgvCommand = Array.isArray(request.command) && request.command.length > 0;
   const hasShellCommand = typeof request.shellCommand === "string";
@@ -1035,6 +1049,7 @@ async function runExec(request) {
     throw childSpawnError;
   }
   const exitCode = normalizeChildExitCode(childStatus, childSignal);
+  const capturedOutput = capture.render();
   if (request.config.runtime.verbose) {
     process.stderr.write(
       `${pc2.dim("sift")} child_exit=${exitCode} captured_chars=${capture.getTotalChars()} capture_truncated=${capture.wasTruncated()}
@@ -1042,9 +1057,25 @@ async function runExec(request) {
     );
   }
   if (!bypassed) {
+    const execSuccessShortcut = getExecSuccessShortcut({
+      presetName: request.presetName,
+      exitCode,
+      capturedOutput
+    });
+    if (execSuccessShortcut && !request.dryRun) {
+      if (request.config.runtime.verbose) {
+        process.stderr.write(
+          `${pc2.dim("sift")} exec_shortcut=${request.presetName}
+`
+        );
+      }
+      process.stdout.write(`${execSuccessShortcut}
+`);
+      return exitCode;
+    }
     const output = await runSift({
       ...request,
-      stdin: capture.render()
+      stdin: capturedOutput
     });
     process.stdout.write(`${output}
 `);
@@ -1141,7 +1172,7 @@ function findConfigPath(explicitPath) {
     }
     return resolved;
   }
-  for (const candidate of DEFAULT_CONFIG_SEARCH_PATHS) {
+  for (const candidate of getDefaultConfigSearchPaths()) {
     if (fs.existsSync(candidate)) {
       return candidate;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bilalimamoglu/sift",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Agent-first command-output reduction layer for agents, CI, and automation.",
   "type": "module",
   "bin": {