@nexus-cortex/core 4.26.0

package/dist/config/SettingsSchema.d.ts

@@ -0,0 +1,219 @@
+/**
+ * Settings Schema
+ *
+ * Defines all configurable settings for Nexus Cortex
+ * Maps to .env file variables and OrchestratorConfig
+ */
+/**
+ * Environment Variables Schema
+ */
+export interface EnvironmentVariables {
+    /** Anthropic API Key for Claude models */
+    ANTHROPIC_API_KEY?: string;
+    /** OpenAI API Key for GPT models */
+    OPENAI_API_KEY?: string;
+    /** Google API Key for Gemini models */
+    GOOGLE_API_KEY?: string;
+    /** Gemini API Key (preferred for Gemini models, falls back to GOOGLE_API_KEY) */
+    GEMINI_API_KEY?: string;
+    /** X.AI API Key for Grok models */
+    XAI_API_KEY?: string;
+    /** DeepSeek API Key for DeepSeek models */
+    DEEPSEEK_API_KEY?: string;
+    /** Inception Labs API Key for Mercury diffusion models */
+    INCEPTION_API_KEY?: string;
+    /** Alibaba Cloud DashScope API Key for Qwen models */
+    DASHSCOPE_API_KEY?: string;
+    /** Zhipu AI API Key for GLM models */
+    ZHIPU_API_KEY?: string;
+    /** Moonshot API Key for Kimi models */
+    MOONSHOT_API_KEY?: string;
+    /** MiniMax API Key for MiniMax models */
+    MINIMAX_API_KEY?: string;
+    /** Cloudflare API Token for Workers AI models (@cf/* models) */
+    CLOUDFLARE_API_TOKEN?: string;
+    /** Cloudflare Account ID — required alongside CLOUDFLARE_API_TOKEN. Endpoint format: api.cloudflare.com/client/v4/accounts/{ID}/ai/v1/... */
+    CLOUDFLARE_ACCOUNT_ID?: string;
+    /** Anthropic authentication method: 'oauth' | 'api-key' | 'auto' */
+    ANTHROPIC_AUTH_METHOD?: string;
+    /** Claude.ai OAuth token override (alternative to ~/.claude/.credentials.json) */
+    CLAUDE_CODE_OAUTH_TOKEN?: string;
+    /** Default model ID to use for new sessions */
+    DEFAULT_MODEL_ID?: string;
+    /** Helper model ID for context management and mentorship */
+    HELPER_MODEL_ID?: string;
+    /** Enable debug logging */
+    DEBUG?: string;
+    /** Project root path */
+    PROJECT_PATH?: string;
+    /** Use emojis in CLI output */
+    USE_EMOJI?: string;
+    /** Enable reactive mentorship system */
+    MENTORSHIP_ENABLED?: string;
+    /** Trigger mentorship on tool errors */
+    MENTORSHIP_TRIGGER_ON_ERROR?: string;
+    /** Error severity threshold for triggering mentorship */
+    MENTORSHIP_ERROR_THRESHOLD?: string;
+    /** Enable keyword triggers (@ultrathink, @analyze, etc.) */
+    MENTORSHIP_KEYWORDS_ENABLED?: string;
+    /** Custom keywords for mentorship (comma-separated) */
+    MENTORSHIP_CUSTOM_KEYWORDS?: string;
+    /** Helper model for mentorship (overrides HELPER_MODEL_ID if set) */
+    MENTORSHIP_HELPER_MODEL?: string;
+    /** Enable turn-based periodic mentorship review */
+    MENTORSHIP_TURN_BASED_ENABLED?: string;
+    /** Number of turns between periodic mentorship reviews */
+    MENTORSHIP_TURN_INTERVAL?: string;
+    /** Enable interleaved thinking assistance for non-reasoning models */
+    MENTORSHIP_INTERLEAVED_THINKING?: string;
+    /** Enable pattern detection for repeated failures */
+    MENTORSHIP_PATTERN_DETECTION?: string;
+    /** Number of similar errors to trigger pattern detection */
+    MENTORSHIP_PATTERN_THRESHOLD?: string;
+    /** Enable Active Discovery guidance to encourage thorough file reading */
+    MENTORSHIP_ACTIVE_DISCOVERY?: string;
+    /** Enable post-turn summary and next-action prediction via helper model */
+    TURN_SUMMARY_PREDICTION?: string;
+    /** Context budget strategy */
+    CONTEXT_BUDGET_STRATEGY?: string;
+    /** Enable Anthropic prompt caching (default: true) */
+    ANTHROPIC_PROMPT_CACHING?: string;
+    /** Session storage directory */
+    SESSION_STORAGE_DIR?: string;
+    /** Enable MCP auto-injection */
+    MCP_AUTO_INJECT?: string;
+    /** Auto-research subagent feature. off = disabled (PM never told about it; main context
+     *  stays clean). native = the PM delegates to autoresearch-agent subagents that run
+     *  experiments with the INTERNAL tools. mcp = the subagents route experiment-running to
+     *  a configured external auto-research MCP server instead. */
+    AUTORESEARCH_AGENTS?: string;
+    /** Per-doc byte cap for injected project docs (CLAUDE.md, MEMORY.md, etc.). 0/unset = unlimited. */
+    SYSTEM_MESSAGE_DOC_MAX_BYTES?: string;
+    /** Maximum tool execution iterations per turn */
+    MAX_TOOL_ITERATIONS?: string;
+    /** Maximum consecutive tool errors before stopping */
+    MAX_CONSECUTIVE_ERRORS?: string;
+    /** Soft tool-call budget per turn */
+    TOOL_BUDGET_SOFT?: string;
+    /** Tool execution timeout in milliseconds */
+    TOOL_TIMEOUT_MS?: string;
+    /** Maximum identical tool call repetitions before detecting loop */
+    MAX_LOOP_REPETITIONS?: string;
+    /** Model that backs WebSearch and WebFetch */
+    WEB_TOOLS_MODEL?: string;
+    /** Enable XAI server-side agentic tools (web_search, x_search, code_execution) */
+    ENABLE_SERVER_SIDE_TOOLS?: string;
+    /** XAI API mode: 'messages' (supports thinking) or 'responses' (supports server-side tools + stateful) */
+    XAI_API_MODE?: string;
+    /** OpenAI API mode */
+    OPENAI_API_MODE?: string;
+    /** Enable Anthropic Programmatic Tool Calling (server-side code execution sandbox) */
+    ENABLE_PTC?: string;
+    /** Enable local code execution for non-PTC models (node -e with tool globals) */
+    ENABLE_LOCAL_CODE_EXECUTION?: string;
+    /** Enable deferred tool loading (essential tools always loaded, others discovered on-demand) */
+    ENABLE_DEFERRED_TOOL_LOADING?: string;
+    /** Enable model router — auto-select model based on task type and benchmark history */
+    MODEL_ROUTER_ENABLED?: string;
+    /** Model router strategy */
+    MODEL_ROUTER_STRATEGY?: string;
+    /** Auto-record benchmark metrics after each turn */
+    MODEL_ROUTER_RECORD?: string;
+    /** Min task-classification confidence (0-1) before model='auto' will route */
+    ROUTER_MIN_CONFIDENCE?: string;
+    /** Min real benchmark samples before model='auto' trusts a task type's recommendation */
+    ROUTER_MIN_SAMPLES?: string;
+    /** Opt-in: use Thompson-sampling (explore/exploit) instead of greedy trust-gated routing for model='auto' */
+    MODEL_ROUTER_EXPLORATION?: string;
+    /** Comma-separated model IDs the router must NEVER auto-select (cost/policy bans) */
+    MODEL_ROUTER_EXCLUDE?: string;
+    /** Enable tmux visual monitoring for parallel agent teams */
+    AGENT_TMUX_MONITOR?: string;
+    /** Mandatory EndTurn pre-delivery self-audit + Stage 2/3 verifiers */
+    CORTEX_ENDTURN_GATE?: string;
+    /** Append each tool decision to .cortex/decisions.jsonl */
+    CORTEX_RECORD_DECISIONS?: string;
+    /** Inject prior decisions as a system-reminder before tool use */
+    CORTEX_LOOKUP_PRIOR_DECISIONS?: string;
+    /** Decision file self-rotates at this byte cap (default 2 MB) */
+    CORTEX_DECISIONS_MAX_BYTES?: string;
+    /** Orchestrator lifecycle mode */
+    CORTEX_MODE?: string;
+    /** Auto-approve ALL tool executions (bypasses permissions) */
+    YOLO?: string;
+    /** Auto-resume last session on startup */
+    AUTO_RESUME?: string;
+    /** HTTP server port */
+    PORT?: string;
+    /** Server URL for HTTP client mode (e.g. http://localhost:4000) */
+    CORTEX_SERVER_URL?: string;
+    /** Show raw API request/response payloads */
+    DEBUG_PAYLOAD?: string;
+    /** Show thinking/reasoning block content in CLI output */
+    DEBUG_THINKING?: string;
+    /** Enable real API smoke tests */
+    ENABLE_SMOKE_TESTS?: string;
+    /** Nvidia API Key */
+    NVIDIA_API_KEY?: string;
+    /**
+     * Comma-separated allow-list of repositories the git/PR tools may operate on.
+     * Supports exact `owner/repo`, `owner/*` wildcards, and `*` (all). Unset → all
+     * repos allowed, with a one-time startup warning. Input format validation
+     * (which blocks shell/argument injection) is always enforced regardless.
+     */
+    GIT_ALLOWED_REPOS?: string;
+    /**
+     * Comma-separated allow-list of git/PR actions:
+     * review,list,create,post-review,clone,worktree,diff,cleanup,status.
+     * Unset or `*` → all actions allowed.
+     */
+    GIT_ALLOWED_ACTIONS?: string;
+    /**
+     * Auth token for gh/git operations. Injected into the subprocess environment
+     * as GH_TOKEN/GITHUB_TOKEN only — never placed on argv or in a clone URL.
+     */
+    GIT_AUTH_TOKEN?: string;
+    /** GitHub (Enterprise) host for git/PR tools. Default: github.com */
+    GIT_HOST?: string;
+    /**
+     * HMAC secret for the /v1/pr/webhook endpoint (GitHub X-Hub-Signature-256).
+     * Unset → the webhook is disabled (returns 401) rather than open.
+     */
+    GITHUB_WEBHOOK_SECRET?: string;
+}
+/**
+ * Configuration Defaults
+ */
+export declare const DEFAULT_SETTINGS: Required<Omit<EnvironmentVariables, 'ANTHROPIC_API_KEY' | 'OPENAI_API_KEY' | 'GOOGLE_API_KEY' | 'GEMINI_API_KEY' | 'XAI_API_KEY' | 'DEEPSEEK_API_KEY' | 'INCEPTION_API_KEY' | 'DASHSCOPE_API_KEY' | 'ZHIPU_API_KEY' | 'MOONSHOT_API_KEY' | 'MINIMAX_API_KEY' | 'CLOUDFLARE_API_TOKEN' | 'CLOUDFLARE_ACCOUNT_ID' | 'CLAUDE_CODE_OAUTH_TOKEN' | 'NVIDIA_API_KEY' | 'GIT_AUTH_TOKEN' | 'GITHUB_WEBHOOK_SECRET'>>;
+/**
+ * Setting Metadata for Interactive Configuration
+ */
+export interface SettingMetadata {
+    key: keyof EnvironmentVariables;
+    displayName: string;
+    description: string;
+    type: 'string' | 'boolean' | 'number' | 'choice' | 'secret';
+    category: 'api_keys' | 'models' | 'system' | 'mentorship' | 'context' | 'session' | 'loop_control' | 'server_side_tools' | 'model_router' | 'agent_workspace' | 'training' | 'runtime';
+    required?: boolean;
+    choices?: string[];
+    default?: string;
+    secret?: boolean;
+    validation?: (value: string) => true | string;
+}
+/**
+ * All Settings Metadata
+ */
+export declare const SETTINGS_METADATA: SettingMetadata[];
+/**
+ * Get settings by category
+ */
+export declare function getSettingsByCategory(category: SettingMetadata['category']): SettingMetadata[];
+/**
+ * Get setting metadata by key
+ */
+export declare function getSettingMetadata(key: keyof EnvironmentVariables): SettingMetadata | undefined;
+/**
+ * Validate setting value
+ */
+export declare function validateSetting(key: keyof EnvironmentVariables, value: string): true | string;
+//# sourceMappingURL=SettingsSchema.d.ts.map

package/dist/config/SettingsSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsSchema.d.ts","sourceRoot":"","sources":["../../src/config/SettingsSchema.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,oBAAoB;IAKnC,0CAA0C;IAC1C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,oCAAoC;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,uCAAuC;IACvC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,iFAAiF;IACjF,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,0DAA0D;IAC1D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,sDAAsD;IACtD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,sCAAsC;IACtC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,uCAAuC;IACvC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,yCAAyC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,gEAAgE;IAChE,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,6IAA6I;IAC7I,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAM/B,oEAAoE;IACpE,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,kFAAkF;IAClF,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAMjC,+CAA+C;IAC/C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,4DAA4D;IAC5D,eAAe,CAAC,EAAE,MAAM,CAAC;IAMzB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,wBAAwB;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,+BAA+B;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IAMnB,wCAAwC;IACxC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,wCAAwC;IACxC,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC,yDAAyD;IACzD,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC,4DAA4D;IAC5D,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC,uDAAuD;IACvD,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC,qEAAqE;IACrE,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,mDAAmD;IACnD,6BAA6B,CAAC,EAAE,MAAM,CAAC;IAEvC,0DAA0D;IAC1D,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,sEAAsE;IACtE,+BAA+B,CAAC,EAAE,MAAM,CAAC;IAEzC,qDAAqD;IACrD,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC,4DAA4D;IAC5D,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC,0EAA0E;IAC1E,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAMrC,2EAA2E;IAC3E,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAMjC,8BAA8B;IAC9B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,sDAAsD;IACtD,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAMlC,gCAAgC;IAChC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,gCAAgC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;kEAG8D;IAC9D,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,oGAAoG;IACpG,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAMtC,iDAAiD;IACjD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,sDAAsD;IACtD,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,qCAAqC;IACrC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,6CAA6C;IAC7C,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,oEAAoE;IACpE,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAM9B,8CAA8C;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,kFAAkF;IAClF,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,0GAA0G;IAC1G,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,sBAAsB;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IAMzB,sFAAsF;IACtF,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,iFAAiF;IACjF,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC,gGAAgG;IAChG,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAMtC,uFAAuF;IACvF,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,4BAA4B;IAC5B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,oDAAoD;IACpD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,8EAA8E;IAC9E,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,yFAAyF;IACzF,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,6GAA6G;IAC7G,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,qFAAqF;IACrF,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAM9B,6DAA6D;IAC7D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAM5B,sEAAsE;IACtE,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAM7B,2DAA2D;IAC3D,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,kEAAkE;IAClE,6BAA6B,CAAC,EAAE,MAAM,CAAC;IAEvC,iEAAiE;IACjE,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAMpC,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,uBAAuB;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,mEAAmE;IACnE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,6CAA6C;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0DAA0D;IAC1D,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,kCAAkC;IAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,qBAAqB;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IAMxB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,IAAI,CAAC,oBAAoB,EAC/D,mBAAmB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,aAAa,GAAG,kBAAkB,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,eAAe,GAAG,kBAAkB,GAAG,iBAAiB,GAAG,sBAAsB,GAAG,uBAAuB,GAAG,yBAAyB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,uBAAuB,CACxW,CAkGA,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,oBAAoB,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC5D,QAAQ,EAAE,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,GAAG,cAAc,GAAG,mBAAmB,GAAG,cAAc,GAAG,iBAAiB,GAAG,UAAU,GAAG,SAAS,CAAC;IACvL,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,CAAC;CAC/C;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,eAAe,EAquB9C,CAAC;AAEF;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,GAAG,eAAe,EAAE,CAE9F;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,oBAAoB,GAAG,eAAe,GAAG,SAAS,CAE/F;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,oBAAoB,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CA2B7F"}