@autorag/librarian 2.0.0

package/dist/cli/commands/status.d.ts

@@ -0,0 +1,7 @@
+import type { CommandContext } from "./types.js";
+/**
+ * `autorag status` — path-opaque snapshot of corpus freshness and index health.
+ * Runs a cheap parse-free staleness scan plus the cached last-refresh outcome.
+ * Model-free. Never emits filesystem paths; only the renderered status text.
+ */
+export declare function runStatus(ctx: CommandContext): Promise<number>;

package/dist/cli/commands/types.d.ts

@@ -0,0 +1,10 @@
+export interface CommandContext {
+    positionals: string[];
+    flags: Record<string, string | boolean | undefined>;
+    json: boolean;
+    debug: boolean;
+    cwd: string;
+    stdout: (line: string) => void;
+    stderr: (line: string) => void;
+    promptYesNo?: (question: string) => Promise<boolean>;
+}

package/dist/cli/commands/watch.d.ts

@@ -0,0 +1,8 @@
+import type { CommandContext } from "./types.js";
+/**
+ * `autorag watch` — keep parsed/BM25/MinSync indexes current.
+ *
+ * - default: long-running recursive fs watch with debounced refresh
+ * - `--once`: single refresh tick (for cron / launchd / Task Scheduler)
+ */
+export declare function runWatch(ctx: CommandContext): Promise<number>;

package/dist/cli/config.d.ts

@@ -0,0 +1,172 @@
+import type { Api, Model } from "@earendil-works/pi-ai";
+import type { AutoRAGAgentOptions } from "../agent/agent.js";
+import type { EnsureMinSyncBinaryOptions, MinSyncEmbedderConfig } from "../minsync/index.js";
+import type { BM25Engine, BM25FallbackMode } from "../retrieval/methods/bm25.js";
+import { type LoadLocalAutoRAGModelsOptions } from "../subagents/local-models.js";
+export declare const DEFAULT_CONFIG_FILENAME = "config.json";
+export declare const LEGACY_CONFIG_FILENAME = "autorag.config.json";
+export { AUTORAG_HOME_ENV, resolveAutoRAGHome } from "../config/home.js";
+export declare class ConfigError extends Error {
+    constructor(message: string);
+}
+/**
+ * Typed BM25 method config persisted in `config.json`. Missing `enabled` means
+ * enabled (true). `false` as a top-level value is also accepted and disables.
+ */
+export interface Bm25MethodConfig {
+    enabled?: boolean;
+    indexPath?: string;
+    fallback?: BM25FallbackMode;
+    forceEngine?: Exclude<BM25Engine, "none">;
+    importBinding?: () => Promise<typeof import("@pngwasi/node-tantivy-binding")>;
+}
+/**
+ * Typed MinSync method config persisted in `config.json`. Missing `enabled`
+ * means enabled (true); `autoInstall` defaults to false. `embedder` carries
+ * the MinSync vector embedder settings validated by {@link normalizeEmbedder}.
+ */
+export interface MinSyncMethodConfig {
+    enabled?: boolean;
+    autoInstall?: boolean;
+    binaryPath?: string;
+    workspacePath?: string;
+    installer?: Omit<EnsureMinSyncBinaryOptions, "root">;
+    embedder?: MinSyncEmbedderConfig;
+}
+/** Indexing method config as it appears in a raw config file (before normalization). */
+export interface RawIndexingMethods {
+    bm25?: Bm25MethodConfig | false;
+    minSync?: MinSyncMethodConfig | false;
+}
+/** Result of {@link normalizeIndexingConfig}: always fully populated. */
+export interface NormalizedIndexingConfig {
+    bm25: Bm25MethodConfig;
+    minSync: MinSyncMethodConfig;
+}
+export interface AgentModelConfig {
+    /** Provider identity used for auth lookup and Model.provider (e.g. openrouter, fireworks, ollama). */
+    provider: string;
+    /** Wire model id sent to the provider API. */
+    id: string;
+    /** Optional display name; defaults to id when omitted. */
+    name?: string;
+    /**
+     * API wire format. Required only when `baseUrl` is set and you need something
+     * other than the default `openai-completions`.
+     */
+    api?: Api;
+    /**
+     * Endpoint base URL. When set, AutoRAG builds a Model from this config
+     * instead of requiring a pi-ai catalog entry. Omit for catalog/local models.
+     */
+    baseUrl?: string;
+    /**
+     * Environment variable name holding the API key (never the secret itself).
+     * Defaults to `${PROVIDER}_API_KEY` when `baseUrl` is set.
+     */
+    apiKeyEnv?: string;
+    reasoning?: boolean;
+    input?: Array<"text" | "image">;
+    contextWindow?: number;
+    maxTokens?: number;
+}
+export interface CliConfig {
+    searchPaths: string[];
+    workspacePath: string;
+    memoryPath: string;
+    /** @deprecated Prefer agents.orchestrator. Kept for legacy single-model configs. */
+    model?: AgentModelConfig;
+    agents?: {
+        orchestrator?: AgentModelConfig;
+        explorer?: AgentModelConfig;
+    };
+    minSync?: MinSyncMethodConfig;
+    bm25?: Bm25MethodConfig;
+    jikji?: Record<string, unknown>;
+    parserOptions?: Record<string, unknown>;
+}
+export interface ResolveConfigInput {
+    flags: Record<string, string | boolean | undefined>;
+    env?: NodeJS.ProcessEnv;
+    cwd?: string;
+    readOnly?: boolean;
+}
+export interface ResolvedConfigPath {
+    configPath: string;
+    explicit: boolean;
+    legacyPath?: string;
+}
+export declare function resolveConfigPath(input: ResolveConfigInput): ResolvedConfigPath;
+/** Normalize inherited legacy paths against the legacy workspace, not the caller's cwd. */
+export declare function normalizeLegacyConfigPaths(partial: Partial<CliConfig>, origin: string): Partial<CliConfig>;
+/**
+ * Normalize and validate a raw MinSync embedder config object.
+ * Rejects unknown fields (e.g. `extraArgs`), invalid `apiKeyEnv` names, and
+ * non-positive numeric fields. Returns a cleaned {@link MinSyncEmbedderConfig}.
+ */
+export declare function normalizeEmbedder(raw: unknown, path: string): MinSyncEmbedderConfig;
+/**
+ * Normalize raw indexing method config into a fully-populated shape.
+ *
+ * - `undefined` / missing key => `{ enabled: true }` (minSync `autoInstall: false`)
+ * - `false` => `{ enabled: false }` (disabled marker)
+ * - object merges with `enabled: true` default and is validated
+ *
+ * Unknown fields, invalid embedder settings, and bad numeric values throw
+ * {@link ConfigError}.
+ */
+export declare function normalizeIndexingConfig(raw: RawIndexingMethods): NormalizedIndexingConfig;
+export declare function resolveConfig(input: ResolveConfigInput): CliConfig;
+/**
+ * Resolve config without writing, migrating, or locking. Health and other
+ * non-destructive preflights use this so legacy cwd configs are read as search
+ * would resolve them but never copied into `~/.autorag/config.json`.
+ */
+export declare function resolveConfigReadOnly(input: ResolveConfigInput): CliConfig;
+export declare function buildAgentOptions(config: CliConfig): Omit<AutoRAGAgentOptions, "model">;
+export declare function resolveModel(config: CliConfig): Model<Api>;
+export interface ResolvedAgentModel {
+    readonly model: Model<Api>;
+    readonly explorerModel: Model<Api>;
+    readonly apiKey?: string;
+    readonly providerApiKeys?: Readonly<Record<string, string>>;
+}
+export type AgentModelResolutionSource = "config" | "flags" | "env" | "local_runtime" | "catalog" | "configured_alias" | "mixed";
+export interface AgentModelAuth {
+    readonly present: boolean;
+    readonly source: "env" | "local_runtime" | "catalog" | "none" | "unknown";
+    readonly envName?: string;
+}
+export interface ResolvedAgentModelRole {
+    readonly provider: string;
+    readonly modelId: string;
+    readonly displayName: string;
+    readonly api: Api;
+    readonly baseUrl: string | undefined;
+    readonly contextWindow: number | undefined;
+    readonly maxTokens: number | undefined;
+    readonly capabilities: {
+        readonly input: readonly string[];
+        readonly reasoning: boolean;
+    };
+    readonly auth: AgentModelAuth;
+    readonly resolutionSource: AgentModelResolutionSource;
+}
+export interface ResolvedAgentModelDetailed {
+    readonly model: Model<Api>;
+    readonly explorerModel: Model<Api>;
+    readonly apiKey?: string;
+    readonly providerApiKeys?: Readonly<Record<string, string>>;
+    readonly roles: {
+        readonly orchestrator: ResolvedAgentModelRole;
+        readonly explorer: ResolvedAgentModelRole;
+    };
+}
+export declare function resolveAgentModel(config: CliConfig, localOptions?: LoadLocalAutoRAGModelsOptions): ResolvedAgentModel;
+export declare function resolveAgentModelDetailed(config: CliConfig, localOptions?: LoadLocalAutoRAGModelsOptions): ResolvedAgentModelDetailed;
+export declare function writeDefaultConfig(path: string, partial: Partial<CliConfig>, opts?: {
+    force?: boolean;
+    atomicCreate?: boolean;
+    cwd?: string;
+    env?: NodeJS.ProcessEnv;
+}): void;

package/dist/cli/index.d.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+interface ParsedArgs {
+    positionals: string[];
+    flags: Record<string, string | boolean>;
+}
+export declare function parseArgs(argv: readonly string[]): ParsedArgs | {
+    error: string;
+};
+export declare function main(argv: readonly string[]): Promise<number>;
+export {};